Computer Science Club of the University of Waterloo's website.
https://csclub.uwaterloo.ca
continuous-integration/drone/push Build is passing
Details
Co-authored-by: ricsign <ricsign123@gmail.com> Reviewed-on: #642 Reviewed-by: Darren Lo <dlslo@csclub.uwaterloo.ca> |
||
---|---|---|
.vscode | ||
components | ||
content | ||
docs | ||
hooks | ||
images | ||
lib | ||
pages | ||
public | ||
scripts | ||
.drone.yml | ||
.eslintignore | ||
.eslintrc.js | ||
.gitignore | ||
README.md | ||
deploy-demo.bash | ||
deploy.sh | ||
next-env.d.ts | ||
next.config.js | ||
package-lock.json | ||
package.json | ||
postcss.config.json | ||
renovate.json | ||
tsconfig.json | ||
types.d.ts | ||
utils.ts |
README.md
README
Documentation
Development
Dependencies
Make sure that you have node
>= 14 and npm
>= 7. Node 14 ships with npm v6,
so if you're using node 14, you would need to upgrade npm. Alternatively you
could also upgrade to node 16, which ships with npm 7.
How to upgrade npm: npm i -g npm
Local
npm install
to install project dependenciesnpm run build:images
to optimize images for the first time after cloningnpm run dev
to run the dev server (http://localhost:3000)
Production
npm install
to install project dependenciesnpm run build
to generate html/css/jsnpm run export
to move the built files (along with assets in the public directory) to the/out
directory- Use your favourite web server to host the files in the
/out
directory. (A very simple one would bepython -m http.server
- not sure if it should actually be used for production :P)
Deploy
groups
(make sure you're in thewww
group)curl -o- https://git.csclub.uwaterloo.ca/www/www-new/raw/branch/main/deploy.sh | bash
(run oncaffeine
)