README.md

Frontend

What does this project do?

This is the frontend repository for our student forum application. This means the codebase will contain only React components and API calls to the backend server repo. If you want to contribute to the backend of our student forum, please request access to the "Backend" repo in the organisation if you dont have read access already.

The frontend will be hooked to Netlify for continuous deployment on the main branch. This also means that all pull requests made will have a nice preview of the changes by viewing the Netlify link.

How do I get started?

Pre-requisites

• install git: https://git-scm.com/downloads
• install node and npm using node version manager (NVM):

  • Windows: https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows

  • MacOS: https://www.newline.co/@Adele/how-to-install-nodejs-and-npm-on-macos--22782681

  • Linux: https://linuxize.com/post/how-to-install-node-js-on-ubuntu-18.04/

Contribute

Refer to CONTRIBUTING.md.

Install

Inside the project, to install dependencies

npm install

Test

Inside the project, to run automated testing

npm test

Run

Inside the project, to run in development mode

npm start

View browser in development mode

http://localhost:3000/

Deployment

Frontend repo's main branch will be automatically deployed to Netlify.

Frontend Contributors:

• Christopher Alba
• Hyung
• Trinh Vo
• Xiaoqi
• Yu Chen