|
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 --> |
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 --> |
| 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 --> |
17 | 3 | # 1. Bmore Responsive |
18 | 4 | An API to drive disaster and emergency response systems. |
19 | 5 |
|
20 | 6 | ## 1.1. Documentation |
21 | 7 | We've included a `docs` folder with a template [Tech Spec](/docs/Tech_Spec.md) and [Best Practices](/docs/Best_Practices.md) document, though using Github's Wiki capabilities is also a good idea. This will get you started with documenting your project. Other documents and relevant information that has no other place can live in the `docs` folder. Replace this paragraph with a brief breakdown of what you've included in your `docs` folder. |
22 | 8 |
|
23 | 9 | ### 1.1.1. API Spec |
24 | | -Our API spec is on Swagger. You can view it here https://app.swaggerhub.com/apis/codeforbaltimore/bmoreResponsive/1.0.0#/ or you can find the `swagger.json` file in our `docs` folder. |
| 10 | +Our API spec is on Swagger. You can view it here https://app.swaggerhub.com/apis/codeforbaltimore/bmoreResponsive/1.0.0#/ or you can find the `swagger.json` file in our `docs` folder and use it via http://localhost:3000 when the app is running locally. |
25 | 11 |
|
26 | 12 | ### 1.1.2. Database Documentation |
27 | 13 | Our database documentation can be found in our `docs` folder under `database.csv`. This documentation was created using SchemaSpy. Instructions for use can be found here https://github.com/bcgov/schemaspy |
|
0 commit comments