|
1 | 1 | [](https://travis-ci.org/CodeForBaltimore/Bmore-Responsive) [](https://codecov.io/gh/CodeForBaltimore/Bmore-Responsive) [](https://snyk.io/test/github/CodeForBaltimore/Bmore-Responsive)
|
2 |
| -<!-- TOC -->autoauto- [1. Bmore Responsive](#1-bmore-responsive)auto - [1.1. Documentation](#11-documentation)auto - [1.1.1. API Spec](#111-api-spec)auto - [1.1.2. Database Documentation](#112-database-documentation)auto- [2. Setup](#2-setup)auto - [2.1. Node and Express setup](#21-node-and-express-setup)auto - [2.2. Environment variables](#22-environment-variables)auto - [2.3. PostgreSQL](#23-postgresql)auto - [2.3.1. Sequelize](#231-sequelize)auto - [2.4. Docker](#24-docker)auto- [3. Using this product](#3-using-this-product)auto - [3.1. Testing](#31-testing)auto- [4. Sources and Links](#4-sources-and-links)autoauto<!-- /TOC --> |
| 2 | +<!-- TOC --> |
| 3 | +- [1. Bmore Responsive](#1-bmore-responsive) |
| 4 | + - [1.1. Documentation](#11-documentation) |
| 5 | + - [1.1.1. API Spec](#111-api-spec) |
| 6 | + - [1.1.2. Database Documentation](#112-database-documentation) |
| 7 | +- [2. Setup](#2-setup) |
| 8 | + - [2.1. Node and Express setup](#21-node-and-express-setup) |
| 9 | + - [2.2. Environment variables](#22-environment-variables) |
| 10 | + - [2.3. PostgreSQL](#23-postgresql) |
| 11 | + - [2.3.1. Sequelize](#231-sequelize) |
| 12 | + - [2.4. Docker](#24-docker) |
| 13 | +- [3. Using this product](#3-using-this-product) |
| 14 | + - [3.1. Testing](#31-testing) |
| 15 | +- [4. Sources and Links](#4-sources-and-links) |
| 16 | +<!-- /TOC --> |
3 | 17 | # 1. Bmore Responsive
|
4 | 18 | An API to drive disaster and emergency response systems.
|
5 | 19 |
|
@@ -67,9 +81,9 @@ docker run -d -e POSTGRES_PASSWORD=<your chosen password> -p 5432:5432 postgres
|
67 | 81 | If you're running a database in another way then we trust you can sort it out on your own because you're awesome :sunglasses:
|
68 | 82 |
|
69 | 83 | ### 2.3.1. Sequelize
|
70 |
| -You can run the application without doing anything and it will create the tables needed to operate automatically. It will not, however, create users. If you would like to seed your database with users you will need to follow a few steps. |
71 |
| -1. You may create your database tables without running the application by running `npm run db-create`. |
72 |
| -2. You can now seed your database by running `npm run db-seed`. |
| 84 | +To properly start the application the database needs to be built by Sequlize ahead of time. To do that run the following commands |
| 85 | +1. You must create your database tables without running the application by running `npm run db-create` first. |
| 86 | +2. _optional_ You can now seed your database if you wish by running `npm run db-seed`. |
73 | 87 |
|
74 | 88 | Example `/migrations` and `/seeders` scripts have been supplied. You can rollback your all seeded data at any time by running `npm run db-unseed` and delete all created tables with `npm run db-delete`.
|
75 | 89 |
|
|
0 commit comments