forked from ProjectSegfault/website
upgrade deps and ignore npm lockfile
This commit is contained in:
22
README.md
22
README.md
@@ -1,9 +1,23 @@
|
||||
# Project Segfault Website
|
||||
Live at [projectsegfau.lt](https://projectsegfau.lt)
|
||||
Live at [projectsegfau.lt](https://projectsegfau.lt).
|
||||
|
||||
## Developing
|
||||
If you use NixOS, clone the repository, cd into the clone and type ``nix-shell``
|
||||
|
||||
If you do not use NixOS, clone the repository, cd into the clone and type in pnpm i. (or just use normal npm, but don't use yarn)
|
||||
### Prerequisites
|
||||
|
||||
To test your changes, type in pnpm run dev (or again, you can use npm, just don't use yarn)
|
||||
- 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!
|
Reference in New Issue
Block a user