This is a step-by-step guide for setting up a development environment on your local machine. Using this environment, you can contribute to the project by working on features, enhancements, bug fixes, etc.
To get started, you should have installed the latest version Visual Studio Code (VS Code) on your local machine. Then please follow the steps.
The production site is located here
Clone the repo into your local machine.
git clone [email protected]:CS3219-SE-Principles-and-Patterns/cs3219-ay2021-s1-project-2020-s1-g01.git
Please ensure that you have installed these software with its at least these versions:
- Node 10.15
- NPM 6.14.8
- MongoDB 4.4 Community Edition
- Navigate to the
apifolder. - Install the dependencies using
npm install. - Build the backend codebase using
npm run watch. - Populate the database using
npm run populate. - Start running the backend server using
npm start.
- Navigate to the
frontendfolder. - Install the dependencies using
npm install. - Start running the frontend server using
npm run dev. - Head over to
localhost:3000on your browser and wait for the server to initialize.
Note: This project works best in Google Chrome Browser.
We have decided to take .next out of the .gitignore, and commit this frontend build folder to the repository.
This is for the sole purpose of deployment only, as the free tier version of our AWS VM deployment was unable to build
the frontend.