Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jai2501 authored Nov 17, 2023
1 parent 34fc44e commit 3d59f14
Showing 1 changed file with 33 additions and 2 deletions.
35 changes: 33 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,33 @@
[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/6BOvYMwN)
# AssignmentTemplate
# PeerPrep App

## Prerequisites
1. Have [Node and NPM installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)

## To Run the App

1. Open Terminal or Powershell.

2. Navigate to directory of your choice
```
cd <directory of your choice>
```

3. Clone this repository into your system
```
git clone https://github.com/CS3219-AY2324S1/ay2324s1-course-assessment-g16.git
```

4. Navigate into the Repository directory
```
cd ay2324s1-course-assessment-g16
```

5. In this Repository directory, navigate into `peer-prep` directory
```
cd peer-prep
```
6. Run the command `npm i` to install dependencies.

7. Run the command `npm start` to start the app.

8. Open browser of your choice and access `http://localhost:3000/`, and you can use the app.

0 comments on commit 3d59f14

Please sign in to comment.