USC Website

Development instructions

1. Install nodeJS, npm and yarn
2. Clone the repo and run yarn to download node_modules folder
3. Copy the env.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.
4. run yarn start to build the local development build, which is visible on localhost
5. run yarn build to prepare the production build

Resources for Getting Started Contributing

• look for good first issues
• fork and pull request workflow
• format of branches: <name>/<describe-feature-added>
• explore index.js, data.js and Events.js to familiarise yourself with the codebase
• understand dependency management
• read up on reactstrap documentation
• read up on file structuring in react
• when everything goes wrong - https://ohshitgit.com
• download more ram