Checkout the live website: wics.uwaterloo.ca
- Clone the project by running:
git clone https://github.com/wics-uw/website-v2.git - Run
yarn installin the project directory to install all the packages - Run
yarn start, you will be able to view the website on http://localhost:3000
-
Make sure you have an account with CSC. (If you do not have one, contact CSC to create one for you and give you access to
wics's server. -
Once you have a CSC account setup, you should be able to
sshinto their servers. For example, in your command line, run
It will prompt you to enter your password immediately.
- You should now be in your own folder, navigate to the
wicsfolder by running
cd ../wics
- Change your role to become a
wicsuser which gives you persmission to change stuff in thewicsfolder
become_club wics
- In the
wicsfolder,www_backupis the old website,wwwis the new website that is live on wics.uwaterloo.ca,website-v2is the project on github. When you've ensured that all the changes are pushed onto Github and merged into themasterbranch, navigate towebsite-v2, pull all the new changes, download all dependencies, and build the project
cd website-v2
git pull
yarn install
yarn build
- You will see a
buildfolder by runningls. This folder contains all the static files we want to copy intowwwfolder. To copy all contents in thebuildfolder into thewwwfilder, run
cp -a build/. ../www
- Navigate to the website wics.uwaterloo.ca, all changes should be live!
- For new features:
initial/feature/ticket#, the ticket # will be the Jira ticket that you are working on
- Always write a descriptive commit message in the following format:
ticket#: description - Write a detailed, but not overly detailed description of the feature or bug fixes when creating a PR
- Always run
yarn installafter pulling from master or checking out to a remote branch - Always update your local master branch by running
git pulleverytime a PR is merged to minimize the need to resolve conflicts when you are creating a PR