docs: initial project README
Signed-off-by: NotAShelf <raf@notashelf.dev> Change-Id: I8e299612bf7afbb87d64ba098496ac536a6a6964
This commit is contained in:
parent
e81736426f
commit
c208da2ec5
1 changed files with 37 additions and 0 deletions
37
README.md
Normal file
37
README.md
Normal file
|
|
@ -0,0 +1,37 @@
|
||||||
|
# frzn.dev
|
||||||
|
|
||||||
|
Hackerspace portal & our glorious homepage.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
### Prerequisites
|
||||||
|
|
||||||
|
- Node.js 22+ (any recent version should just work)
|
||||||
|
- pnpm
|
||||||
|
|
||||||
|
### Setup
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install all dependencies
|
||||||
|
$ pnpm install
|
||||||
|
```
|
||||||
|
|
||||||
|
### Commands
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Common tasks
|
||||||
|
$ pnpm dev # Start development server (http://localhost:4321)
|
||||||
|
$ pnpm build # Build for production
|
||||||
|
$ pnpm preview # Preview production build
|
||||||
|
$ pnpm fmt # Format code
|
||||||
|
$ pnpm fmt:check # Check formatting
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tech Stack
|
||||||
|
|
||||||
|
[Astro]: https://astro.build/
|
||||||
|
[@astrojs/node]: https://docs.astro.build/en/guides/integrations-guide/node/
|
||||||
|
|
||||||
|
This site is built with [Astro], using Astro 6.x with server-side rendering
|
||||||
|
features powered by [@astrojs/node]. The stack is relatively simple, and should
|
||||||
|
be easily extensible without sacrificing from maintainability in the long term.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue