diff --git a/Assignment1.md b/Assignment1.md new file mode 100644 index 00000000..b05358d0 --- /dev/null +++ b/Assignment1.md @@ -0,0 +1,12 @@ +# Assignment 1: CRUD Question Bank + +## To setup and execute + +1. Download the zip file named `ay2324s1-course-assessment-g17-Assignment-1-updated.zip` from [Assignment-1-updated](https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g17/releases/tag/Assignment-1-updated). +2. Unzip the file and navigate to the folder `ay2324s1-course-assessment-g17-Assignment-1-updated`. +3. Set up the environment variables in `.env` for `backend/question-service` and `frontend`. +4. `cd` into `backend/question-service` and `frontend`. Run `npm install` to install the dependencies for `question-service` and `frontend`. + + Note: You may need to run `npm i --save-dev @types/cors` and `npm i --save-dev @types/express` should you encounter any errors. + +5. In `frontend` and `backend/question-service`, run `npm start`. \ No newline at end of file