Computer Science Club of the University of Waterloo's website. https://csclub.uwaterloo.ca
Go to file
Renovate Bot f5db71c56e
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/pr Build is failing Details
Update dependency eslint-plugin-react-hooks to v5
2024-10-12 12:08:05 +00:00
.vscode Add Faizaan's Name and Picture to Website (#703) 2024-05-31 19:37:46 -04:00
components add light and dark mode scrollbar (#571) 2023-04-28 18:34:46 -04:00
content Add ray's desc (#719) 2024-09-16 17:29:57 -04:00
docs Add some docs about architecture (#459) 2022-06-19 01:45:41 -04:00
hooks Meet the Team page (#94) 2021-08-23 11:11:42 -04:00
images Add Faizaan's Name and Picture to Website (#703) 2024-05-31 19:37:46 -04:00
lib Meet the team sub-issue 2,3,4 (#592) 2023-07-28 14:27:05 -04:00
pages Update team page (#648) 2024-01-26 19:51:25 -05:00
public Create members.json api (#489) 2022-08-08 04:31:15 -04:00
scripts Update team page (#648) 2024-01-26 19:51:25 -05:00
.drone.yml Add ray's desc (#719) 2024-09-16 17:29:57 -04:00
.eslintignore Add mdx support and playground 2021-04-26 19:16:55 -04:00
.eslintrc.js Add CSC Kickoff Event News (#510) 2022-10-05 20:20:47 -04:00
.gitignore Add S23 elections results (#576) 2023-05-11 12:50:49 -04:00
README.md Add some docs about architecture (#459) 2022-06-19 01:45:41 -04:00
deploy-demo.bash Script to deploy site to your CSC website (#99) 2021-08-03 19:17:08 -04:00
deploy.sh always remove tmpdir in deploy.sh (#530) 2022-11-27 15:00:07 -05:00
next-env.d.ts Upgrade Next, React, TypeScript (#91) 2021-08-01 17:54:25 -04:00
next.config.js Update content for advice pages (#299) 2021-09-11 16:00:22 -04:00
package-lock.json Update dependency eslint-plugin-react-hooks to v5 2024-10-12 12:08:05 +00:00
package.json Update dependency eslint-plugin-react-hooks to v5 2024-10-12 12:08:05 +00:00
postcss.config.json Convert rems to px and use calc to convert on build time 2021-05-24 18:58:28 +00:00
renovate.json Force node 16+ and npm 7+ in renovate (#192) 2021-08-28 00:05:56 -04:00
tsconfig.json Dynamically generate event calendar (#332) 2021-09-27 16:20:18 -04:00
types.d.ts Add Multiple News Items on Homepage and Single News Item Page (Closes #281) (#390) 2022-02-23 00:15:37 -05:00
utils.ts Create members.json api (#489) 2022-08-08 04:31:15 -04:00

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 dependencies
  • npm run build:images to optimize images for the first time after cloning
  • npm run dev to run the dev server (http://localhost:3000)

Production

  • npm install to install project dependencies
  • npm run build to generate html/css/js
  • npm 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 be python -m http.server - not sure if it should actually be used for production :P)

Deploy

  • groups (make sure you're in the www group)
  • curl -o- https://git.csclub.uwaterloo.ca/www/www-new/raw/branch/main/deploy.sh | bash (run on caffeine)