yarn
to download node_modules
folderenv.example
file into .env
at the root directory,
Including in the appropriate API keys. Obtain GCal from your own generation of an API key, and ask Admins for Firebase.yarn start
to build the local development build, which is visible on localhostyarn build
to prepare the production buildInstall Windows Subsystem for Linux and continue below.
These are some basic development tools you'll need to get started on this project. If you can, do a quick 2 minute read up on what each of them does! It'll help make sense of the steps later on.
git
NodeJS 10.x.x and npm
nvm install 10.13.0
yarn
The first steps in the fork and pull request workflow!
Fork this repo!
Enable Travis CI on your repo (You'll need this to merge a pull request later on)
Clone your fork of the repo to your local machine
git clone https://github.com/USERNAME/usc-website.git
The USC website interacts with the USC Google Calendar and Firebase. These interactions require authentication through some secret API keys.
Copy the env.example
file into .env
in the usc-website/
directory
cp .env.example .env
Google Calendar
.env
file!Firebase
.env
file!For most part, you'll be testing the changes you make on a development server on your local machine (your laptop, PC, etc) and any changes you make will be reflected immediately.
Development
yarn start
Build
yarn build
<name>/<describe-feature-added>
index.js
, data.js
and Events.js
to familiarise yourself with the codebase