Computer Science Club of the University of Waterloo's website. https://csclub.uwaterloo.ca
Go to file
Amy Wang aae5c9adef
continuous-integration/drone/push Build is passing Details
Image Optimization Script (#348)
A build-time script to optimize images. Note that going forward, all images should be placed in `images` instead of `public/images`.

Co-authored-by: Amy <a258wang@uwaterloo.ca>
Reviewed-on: #348
Reviewed-by: Aditya Thakral <a3thakra@csclub.uwaterloo.ca>
Reviewed-by: n3parikh <n3parikh@csclub.uwaterloo.ca>
Co-authored-by: Amy <a258wang@csclub.uwaterloo.ca>
Co-committed-by: Amy <a258wang@csclub.uwaterloo.ca>
2021-10-31 16:58:14 -04:00
.vscode Fix constitution formatting (#216) 2021-08-30 09:12:39 -04:00
components Add scrolling to Organized Content sidebar on smaller desktop screens (#322) 2021-10-04 18:57:11 -04:00
content fix typo in Yanni's username 2021-10-22 18:24:55 -04:00
hooks Meet the Team page (#94) 2021-08-23 11:11:42 -04:00
images Image Optimization Script (#348) 2021-10-31 16:58:14 -04:00
lib Image Optimization Script (#348) 2021-10-31 16:58:14 -04:00
pages Add lang attribute to html (#325) 2021-09-22 17:12:36 -04:00
public Image Optimization Script (#348) 2021-10-31 16:58:14 -04:00
scripts Image Optimization Script (#348) 2021-10-31 16:58:14 -04:00
.drone.yml Image Optimization Script (#348) 2021-10-31 16:58:14 -04:00
.eslintignore Add mdx support and playground 2021-04-26 19:16:55 -04:00
.eslintrc.js Use eslint-plugin-import to bring some order to the mess (#132) 2021-08-13 04:16:37 -04:00
.gitignore Image Optimization Script (#348) 2021-10-31 16:58:14 -04:00
README.md Final changes for deploying (#279) 2021-09-03 18:34:56 -04:00
deploy-demo.bash Script to deploy site to your CSC website (#99) 2021-08-03 19:17:08 -04:00
deploy.sh increase processes ulimit 2021-09-11 17:17:28 -04: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 Image Optimization Script (#348) 2021-10-31 16:58:14 -04:00
package.json Image Optimization Script (#348) 2021-10-31 16:58:14 -04: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 permalink in event card (#316) 2021-09-12 20:15:31 -04:00
utils.ts Add events archive (#187) 2021-08-28 15:52:45 -04:00

README.md

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

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)