Skip to content
Snippets Groups Projects
Commit 36b13d86 authored by Jay Patel's avatar Jay Patel
Browse files

Update README.md

parent afb23460
Branches
No related tags found
1 merge request!4Merging into Master
......@@ -18,14 +18,43 @@ color).
- Socket.io
## Getting Started
To launch this project, follow these steps:
To launch this project, you can download the source code as a zip file or you can clone the repo to your local machine. After you have downladed the project to your local machine, follow the steps below:
- Database initialization: (when running for first time or after deleting the database)
1. cd into db folder
2. execute the command `./db.bash -init` to initialize our Database
### 1. Open command-line and navigate to the project directory
```bash
$ cd cs-375-project
```
- Database maintaining:
### 2. Initialize (when running for first time or after deleting the database) the database by:
**Navigate to the "db" directory and initialize database by executing the commands below**
```bash
$ cd db
$ ./db.bash -init
```
**Database maintaining:**
1. execute the command `./db.bash -backup` to save a local backup of the Database
2. execute the command `./db.bash -update` to update the current database with the latest one
3. execute the command `./db.bash -destroy` to delete database
### 3. Set database password for Postgres
**Navigate back to the home directory of the project folder**
```bash
$ cd ..
$ vim env.json
Type in your Postgres password where the line reads "password": "" in between the quotes.
```
### 5. Initialize Express and Socket.io modules:
**Navigate back to the home directory of the project folder**
```bash
$ cd ..
$ npm install express
$ npm install socket.io
```
### 5. Launch server:
```bash
$ node server.js
```
### 6. Visit `http://localhost:3000`
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please to comment