Skip to content

Commit 3d59f14

Browse files
authored
Update README.md
1 parent 34fc44e commit 3d59f14

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,33 @@
1-
[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/6BOvYMwN)
2-
# AssignmentTemplate
1+
# PeerPrep App
2+
3+
## Prerequisites
4+
1. Have [Node and NPM installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
5+
6+
## To Run the App
7+
8+
1. Open Terminal or Powershell.
9+
10+
2. Navigate to directory of your choice
11+
```
12+
cd <directory of your choice>
13+
```
14+
15+
3. Clone this repository into your system
16+
```
17+
git clone https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g16.git
18+
```
19+
20+
4. Navigate into the Repository directory
21+
```
22+
cd ay2324s1-course-assessment-g16
23+
```
24+
25+
5. In this Repository directory, navigate into `peer-prep` directory
26+
```
27+
cd peer-prep
28+
```
29+
6. Run the command `npm i` to install dependencies.
30+
31+
7. Run the command `npm start` to start the app.
32+
33+
8. Open browser of your choice and access `http://localhost:3000/`, and you can use the app.

0 commit comments

Comments
 (0)