Our application is accessible at https://clean-cheeks.vercel.app
Our backend documentation is available at https://cleancheeks-backend.onrender.com/api/v1/docs/
The endpoints themselves are accessible at https://cleancheeks-backend.onrender.com
Service | Port |
---|---|
Frontend | 3000 |
Backend | 8000 |
- Create a
.env
file in/frontend
to store app credentials. Refer to frontend/.env.sample for more info. - Install npm packages using
npm i
. - Run the react app using
npm start
.
Note: It would be better to start the backend service before starting the frontend app since it relies on the data there.
- Create a
.env
file in/backend
to store app credentials. Refer to backend/.env.sample for more info. - Install npm packages using
npm i
. - Run
npm run db:create
to create thepostgres
database on your local machine. - There are two ways to run the backend service
- For first-time initialisation, run
npm start
. This runs all the database commands to clear and populate the database. You can also run this if you want to reset the database to its initial state. - For subsequent initialisations, run
npm run deploy
to start the backend service.
- For first-time initialisation, run
Note: The API endpoint can be found at http://localhost:8000/api/v1/
Name | Matric No. | Contributions |
---|---|---|
Keane Chan Jun Yu | A0205678W | Full Stack |
Wu Peirong | A0199926E | Full Stack |
Tan Su Yin | A0205369B | Full Stack, UI/UX |
Terence Ho Wei Yang | A0196511E | Full Stack |