webcompile/README.md

27 lines
960 B
Markdown

# Project Segfault Website
Live at [projectsegfau.lt](https://projectsegfau.lt).
## Developing
### Prerequisites
- Install [node.js](https://nodejs.org).
- Install [pnpm](https://pnpm.io/) (optional, although strongly recommended).
- Learn [Svelte](https://svelte.dev).
### Universal
1. Clone the repository using `git clone https://github.com/ProjectSegfault/website`.
2. Change directory into the clone using `cd ./website`.
3. Install dependencies using `pnpm i` (recommended) or `npm i`.
4. Run the dev server using `pnpm dev` (recommended) or `npm run dev`.
5. Open a browser on `http://localhost:5173/` and you should see the website running locally!
### NixOS
1. Clone the repository using `git clone https://github.com/ProjectSegfault/website`.
2. Change directory into the clone using `cd ./website`.
3. In the same terminal type `nix-shell`.
4. Open a browser on `http://localhost:5173/` and you should see the website running locally!