Skip to content

Commit

Permalink
Add Assignment 1 readme
Browse files Browse the repository at this point in the history
  • Loading branch information
carriezhengjr committed Nov 17, 2023
1 parent fe481ca commit 92c3fd3
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions Assignment1.md
Original file line number Diff line number Diff line change
@@ -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`.

0 comments on commit 92c3fd3

Please sign in to comment.