Add README.md

README.md

@@ -2,10 +2,56 @@
 
 # CS3219 Project (PeerPrep) - AY2425S1
 
-## Group: Gxx
+## Group: G01
 
-### Note:
+### Production:
+Deployed link: https://g01-peer-prep.vercel.app/
+
+Admin account (if needed): 
+- email: `[email protected]`
+- password: `123123`
+
+### Local (How to test): 
+
+#### Setting up: 
+1. Clone [our repo](https://github.com/CS3219-AY2425S1/cs3219-ay2425s1-project-g01.git) on your preferred IDE
+2. Open 2 terminals on your IDE (One for Frontend, One for Backend)
+3. Ensure you're on our latest commit on main branch
+
+#### Spin up backend
+Before proceeding to the following procedures, install Docker Desktop
+
+Run the docker containers by entering the following command in the root directory:
+```
+docker compose -f docker-compose.yml up -d
+```
+> [!WARNING]
+> Only one instance of containers should be running at any point in time.
+> That is, let your other friends know that they need to close theirs if you're testing!
+
+To close your containers, run the following command in the root directory:
+```
+docker compose -f docker-compose.yml down
+```
+
+#### Then, spin up the frontend 
+1. Install [Node](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+2. On your frontend terminal in the root folder (cs3219-ay2425s1-project-g01), navigate to the `peer-prep-fe` subfolder:
+```
+cd peer-prep-fe
+```
+3. Run the command `npm install` to install the required packages
+```
+npm install
+```
+4. Then, run the command `npm install -g @angular/cli`
+```
+npm install -g @angular/cli
+```
+5. Once done, run the command `ng serve` to start the local development server
+```
+ng serve
+```
+6. Once the following content appears in the terminal, the local development server has been successfully started
+<img width="500" alt="image" src="https://github.com/user-attachments/assets/d92add4f-63fa-4456-a62a-c2fdbd2d864c">
 
-- You can choose to develop individual microservices within separate folders within this repository **OR** use individual repositories (all public) for each microservice.
-- In the latter scenario, you should enable sub-modules on this GitHub classroom repository to manage the development/deployment **AND** add your mentor to the individual repositories as a collaborator.
-- The teaching team should be given access to the repositories as we may require viewing the history of the repository in case of any disputes or disagreements.