11# Site source code
22
3- This is source code for the https://serenity-rs.github.io site, built using
4- [ Vite] [ vite ] .
3+ The source code for the https://serenity-rs.github.io site.
4+
5+ The site is built using [ Vite] [ vite ] .
56
67## Contributing
78
8- If you wish to contribute, simply set up a [ Node.js] [ node ] environment with the
9- NPM package manager.
9+ To contribute, set up a [ Node.js] [ node ] environment with the PNPM package
10+ manager. You may install PNPM using the system package manager, `npm install -g
11+ pnpm` , or ` corepack enable pnpm`.
12+
13+ Install dependencies with ` pnpm install ` .
1014
11- Once you have Node and NPM, install the necessary dependencies with ` npm install ` .
15+ To develop the site, use ` pnpm run dev ` to spin up Vite's dev server to test
16+ changes locally. The dev server is configured to run on ` localhost:3000 ` (or
17+ whichever spare port was selected in case ` 3000 ` was already taken).
1218
13- Afterwards, you may use ` npm run dev ` to run a dev server to test changes
14- locally, which will run on ` localhost:3000 ` . Once you are satisfied with the
15- changes, run ` npm run build ` to build the site. This will create a minified,
16- bundled version of the site into the ` docs/ ` directory, which can directly be
17- served by a HTTP server like [ Nginx] [ nginx ] , though, of course, this site is
18- meant to be run on Github Pages.
19+ Once you are satisfied with the changes, run ` pnpm run build ` to build the site,
20+ which will create a minified, bundled version of the site into the ` dist/ `
21+ directory. The contents of the ` dist/ ` directory can directly be served by a
22+ static HTTP server like [ Nginx] [ nginx ] , although this site is meant to run on
23+ Github pages.
1924
20- This site uses [ TypeScript] [ ts ] and [ SCSS] [ sass-scss ] instead of regular
21- JavaScript and CSS. When writing CSS, the [ BEM] [ bem ] methodology is used.
25+ This site uses [ TypeScript] [ ts ] for scripting, and utilises the [ BEM] [ bem ] methodology for CSS.
2226
2327Media files, like images, sounds, and videos, are stored in the ` public/ `
2428directory.
@@ -27,7 +31,6 @@ directory.
2731[ node ] : https://nodejs.org
2832[ nginx ] : https://nginx.org
2933[ ts ] : https://typescriptlang.org
30- [ sass-scss ] : https://sasscss.com
3134[ bem ] : https://getbem.com/
3235
3336## License
0 commit comments