Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
codewizard0803 authored and jupiter83 committed Jul 4, 2019
1 parent edaf96b commit 22a55f8
Showing 1 changed file with 6 additions and 61 deletions.
67 changes: 6 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,11 @@
# Gatorbnb
- SFSU housing / real estate website full stack project
- Mobile friendly
- Demo URL (Amazon EC2): http://13.57.19.213/

# Development
- React.js
- Node.js/Expres.js
- PostgreSQL
- ExpressJS
- ReactJS
- NodeJS
- NPM

# Screenshots
![alt text](https://i.imgur.com/6f8DvxQ.png)
Expand All @@ -18,62 +15,10 @@
![alt text](https://i.imgur.com/YNbJ7SR.png)
![alt text](https://i.imgur.com/dqY8Ryy.png)

# How to install Repository

Clone the repo:

```sh
git clone https://github.com/CSC-648-SFSU/csc648-sp19-team05.git
```

# How to Build and Set Up

- Navigate to root repo and run the following command to download all dependencies Express:

```sh
npm install
```

- Navigate to the /client and run the following command to download all dependencies for React:

```sh
npm install
```

- Navigate back to the root repo and create a new file .env
- Set up the .env file with correct variables (username, password, port, database_name)

```sh
LOCAL_DATABASE_URL=postgres://username:password@localhost:port/database_name
BACKEND_URL=http://localhost:5000/api
SESSION_SECRET=CATKEYBOARD
```

- Migrate the database using Sequelize:

```sh
npm run db:migrate
```

- Seed the database by running:

```sh
npm run db:seed
```

# How to Run

- Run backend API in development by running the following command from root repo:

```sh
npm run start:dev
```

- Open a new terminal and navigate to /client and run the following command to run React

```sh
npm start
```
# Admin
![alt text](https://i.imgur.com/82B6TA5.png)
![alt text](https://i.imgur.com/Ro37t1U.png)
![alt text](https://i.imgur.com/oOl6G6q.png)

# Team Member Contribution

Expand Down

0 comments on commit 22a55f8

Please sign in to comment.