Final doc tweaks

Author: stoopidJSON

CONTRIBUTING.md

@@ -1,12 +1,10 @@
 # Contributing
-
 When contributing to this repository, please first discuss the change you wish to make via issue,
 email, slack, or any other method with the contributes of this repository, or Code for Baltimore, before making a change. 
 
 Please note we have a [Code of Conduct](/docs/Code_of_Conduct.md), please follow it in all your interactions with the project.
 
 ## Overview
-
 In the event of a disaster a municipality or state may have need to check in on the status of all healthcare providers, 
 or other types of entities, within in the jurisdiction. This system will provide methods for healthcare providers and 
 entities to check-in during disasters, and update their contact information during non-emergency periods. During an 
@@ -21,7 +19,6 @@ to help the municipality prioritize its call/check-in list and response plan. Ad
 information regularly during non-emergency times to ensure the municipality has the most up-to-date information for each entity.
 
 ### Non Goals
-
 What will this project not accomplish during its initial creation?
 
 - No front-end website or app
@@ -30,7 +27,6 @@ What will this project not accomplish during its initial creation?
 - Statistical or analytical endpoints
 
 ### Minimum Viable Product
-
 To use this product as quickly as possible we will be implementing the following features:
 - User creation
 - Contact creation
@@ -39,15 +35,14 @@ To use this product as quickly as possible we will be implementing the following
 - Contact single-use login check-in ability
 
 ### Roadmap
-
-We estimate the API will be at v1.0.0 by the end of March. Further Milestones and advancements can be viewed on the [Projects page](https://github.com/CodeForBaltimore/Bmore-Responsive/projects)
+Milestones and project timelines can be viewed on the [Projects page](https://github.com/CodeForBaltimore/Bmore-Responsive/projects)
 
 ## Technology and Code
 
 This project will make exclusive use of open-source software, packages, and contributions. The application is built with the following
 technologies:
 
-- Javascript/Typescript
+- Javascript (ES6)
 - [Node.js](https://nodejs.org/en/)
 - [Express.js](https://expressjs.com/)
 - [Sequelize](https://sequelize.org/v3/)
@@ -60,7 +55,6 @@ Please see our [Best Practices](/docs/Best_Practices.md) for code standards, git
 documented code.
 
 ### Pull Request Process
-
 1. Ensure you thoroughly fill out the pull request form presented when submitting the request. 
    This includes listing what work was done, what issues are resolved by that work, what tests
    have been added, how to perform other tests or run the code, and other potentially relevant
@@ -71,7 +65,6 @@ documented code.
    do not have permission to do that, you may request the second reviewer to merge it for you.
 
 ## Contact
-
 The best ways to get in touch with us is via Slack. An active Slack link can be found on our website:
 
 ***[codeforbaltimore.org](https://codeforbaltimore.org/)***

README.md

@@ -12,13 +12,15 @@ An API to drive disaster and emergency response systems.
     - [Documentation](#documentation)
         - [API Spec](#api-spec)
         - [Database Documentation](#database-documentation)
+        - [Infrastructure and Deployment](#infrastructure-and-deployment)
 - [Setup](#setup)
     - [Node and Express setup](#node-and-express-setup)
     - [Environment variables](#environment-variables)
         - [Example .env](#example-env)
     - [PostgreSQL](#postgresql)
         - [Sequelize](#sequelize)
     - [Docker](#docker)
+        - [docker-compose](#docker-compose)
 - [Using this product](#using-this-product)
     - [Testing](#testing)
 - [Sources and Links](#sources-and-links)
@@ -28,25 +30,33 @@ An API to drive disaster and emergency response systems.
 
 ## Documentation
 Detailed documents describing this project and its use are available in this repository. The documentation currently available is as follows:
--   [Best Practices](BEST_PRACTICES.md)
--   [Code of Conduct](CODE_OF_CONDUCT.md)
--   [Tech Spec](TECH_SPEC.md)
+-   [Best Practices](/docs/Best_Practices.md)
+-   [Code of Conduct](/docs/Code_of_Conduct.md)
+-   [Sequelize](/sequelize/README.md)
+-   [Tech Spec](/docs/Tech_Spec.md)
+-   [Terraform](/terraform/README.md)
 
 ### API Spec
-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.  
+Our API spec is on Swagger. You can view it here https://app.swaggerhub.com/apis/codeforbaltimore/bmoreResponsive or you can find the `swagger.json` file in our `docs` folder and use it via http://localhost:3000/api-docs/ when the app is running locally.  
 
 ### Database Documentation
-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
+Our database documentation can be found in the `/sequelize` directory or you can [click here](/sequelize/README.md)
+
+### Infrastructure and Deployment
+We have included a `terraform` option to deploy to AWS. For more information on how to use this feature, please see the [terraform](/terraform/README.md) directory.
 
 # Setup
-A `Dockerfile` and `docker-compose` file have been included for convenience, however this may not be the best local setup for this project. For more information on how to use Docker with this project, please see the [docker section](#docker).
+This setup section will focus on setting up the local dev environment. For more detailed instructions for how to deploy this to a production environment please see the section above this one :point_up:
 
 To work on this project you should have:
--   NodeJS
--   PostgreSQL (can be in Docker)
--   Docker (optional)
+-   [Node.js](https://nodejs.org/en/)
+-   [PostgreSQL](https://www.postgresql.org/) (can be in Docker)
+-   [Docker](https://www.docker.com/) (optional)
+-   [Terraform](https://www.terraform.io/) (optional, for AWS deploy)
 Once you have the prerequisite software installed you can proceed to setup this application.
 
+A `Dockerfile` and `docker-compose` file have been included for convenience, however this may not be the best local development setup for this project. For more information on how to use Docker with this project, please see the [docker section](#docker).
+
 ## Node and Express setup
 This application is designed to work as an API driven by Express. To setup your environment first you must install all required dependencies by running the following command from the root of your project directory:
 ```
@@ -62,7 +72,7 @@ echo 'NODE_ENV=local
 PORT=<your port>
 DATABASE_SCHEMA=<your database schema>
 JWT_KEY=<your secret JWT seed phrase or key>
-DATABASE_URL=<your connection string based on above variables>
+DATABASE_URL=<your db connection string>
 ' >> ./.env
 ```
 The `DATABASE_URL` is not a very clear var name, and the string is broken down as `postgres://username:password@host:port/database_name`
@@ -75,10 +85,10 @@ The various variables are defined as follows:
 - `DATABASE_URL` = The URL string for your db connection. For example: `postgres://user:[email protected]:5432/dbname`
 - `DATABASE_SCHEMA` = Your local database schema. Postgres default is `public`.
 - `JWT_KEY` = A secret value to generate JWT's locally. 
-- `SMTP_HOST` = hostname for the SMTP server used to send notification emails
-- `SMTP_PORT` = port number for the SMTP server used to send notification emails
-- `SMTP_USER` = username for the SMTP server used to send notification emails
-- `SMTP_PASSWORD` = password for the SMTP server used to send notification emails
+- `SMTP_HOST` = _optional_ hostname for the SMTP server used to send notification emails
+- `SMTP_PORT` = _optional_ port number for the SMTP server used to send notification emails
+- `SMTP_USER` = _optional_ username for the SMTP server used to send notification emails
+- `SMTP_PASSWORD` = _optional_ password for the SMTP server used to send notification emails
 - `BYPASS_LOGIN` = _optional_  Allows you to hit the endpoints locally without having to login. If you wish to bypass the login process during local dev, set this to `true`.
 
 _We do not recommend using the default options for PostgreSQL. The above values are provided as examples. It is more secure to create your own credentials._
@@ -102,7 +112,7 @@ BYPASS_LOGIN=true
 ## PostgreSQL
 ***You will need a PostgreSQL database running locally to run this application locally.*** You may setup PostgreSQL however you wish, however we recommend using Docker using the instructions found here: https://hub.docker.com/_/postgres
 
-If you are using the Docker method you may spin up your database layer by running this command:
+If you are using Docker you may spin up your database layer by running this command:
 ```
 docker run -d -e POSTGRES_PASSWORD=<your chosen password> -p 5432:5432 postgres
 ```
@@ -116,21 +126,15 @@ To properly start the application the database needs to be built by Sequlize ahe
 
 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`.
 
-To create new models, migrations, and seeders you _must_ use the Sequelize CLI commands. Full documentation is here https://sequelize.org/master/manual/migrations.html but here are a few useful commands:
-- `npx sequelize-cli model:generate --name User --attributes firstName:string,lastName:string,email:string` - Creates a model under `/src/models` and a migration script.
-- `npx sequelize-cli seed:generate --name demo-user` - Creates a seeder for the `User` model and migration previously setup.
-
 ## Docker
-To use the `docker-compose.yml` file included you will first need to set [environment variables](#environment-variables). You **MUST** set your `DATABASE_HOST` to `db` to use the `docker-compose` solution. 
-
-If you are running your own database, but want to use the `Dockerfile` you will need to run that this way:
+You can build and run the application in Docker locally by running the following commands:
 ```
 docker build -t bmoreres .
 docker run -d -p 3000:3000 --env-file=.env bmoreres
 ```
-Note that `DATABASE_URL` host location will be different depending on what OS you're using. On Mac it is `docker.for.mac.host.internal` and on Windows it is `docker.for.win.host.internal` if using `docker-compose` it will be `db`
+Note that `DATABASE_URL` host location will be different depending on what OS you're using. On Mac it is `docker.for.mac.host.internal` and on Windows it is `docker.for.win.host.internal` if using `docker-compose` it will be `db`. Please see [Example .env](#example-env) for more information.
 
-You can manually set the environment variables and not use a `.env` file by setting the following vars:
+Alternatively you can manually set the environment variables and not use a `.env` file by setting the following vars:
 ```
 -e NODE_ENV=development
 -e PORT=3000 
@@ -139,8 +143,12 @@ You can manually set the environment variables and not use a `.env` file by sett
 -e DATABASE_DATABASE_SCHEMA=<your database schema>
 ```
 
+### docker-compose
+To use the `docker-compose.yml` file included you will first need to set [environment variables](#environment-variables). You **MUST** set your `DATABASE_HOST` to `db` to use the `docker-compose` solution. It is not recommended to use `docker-compose` for any reason other than to test a solution for a separate front-end component. 
+
 # Using this product
-You may use this product to create and manage users for your front-end. More to come! 
+You may use this product to create and manage users for your front-end. 
+
 To run the application--after the above steps are completed--run `npm start`.
 
 ## Testing
@@ -151,8 +159,6 @@ To check your linting you may run `npm run lint` and to format and automatically
 # Sources and Links
 We are also building a front-end application called [Healthcare Rollcall](https://github.com/CodeForBaltimore/Healthcare-Rollcall) to interact with this backend API. To view that project, or to contribute to it, please visit the repo here: https://github.com/CodeForBaltimore/Healthcare-Rollcall
 
-We will be including multi-repo build processes with the front-end that will reference this project.
-
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

docs/Best_Practices.md

@@ -59,7 +59,7 @@ Static code analysis tools should be used when possible, to monitor and improve
 All code work should be done in an isolated or feature branch off of the `master` branch.  Before starting work on new code, developers should create their feature branch using a standard naming convention determined by the project.  
 
 ### Branch Names
-Branch names should follow this patter: `<your github username>/issue-<github issue number>`. This will ensure there are no branch name conflicts, and anyone looking for your branch will know what it is called based on the issue addressed. For example if your username was letsGoOs, and you were working on issue 8, then your branch name would be `letsGoOs/issue-8`. If you wanted to make a new branch to continue your work on your issue then add a suffix with an incremented number. To continue the previous example if you wanted to make a second branch for your issue 8 work your second branch would be called `letsGoOs/issue-8-2`.
+Branch names should follow this patter: `<your github username>/issue-<github issue number>`. This will ensure there are no branch name conflicts, and anyone looking for your branch will know what it is called based on the issue addressed. For example if your username was `letsGoOs`, and you were working on issue 8, then your branch name would be `letsGoOs/issue-8`. If you wanted to make a new branch to continue your work on your issue then add a suffix with an incremented number. To continue the previous example if you wanted to make a second branch for your issue 8 work your second branch would be called `letsGoOs/issue-8-2`.
 
 ### Merging and Pull Requests
 

sequelize/README.md

@@ -18,4 +18,9 @@ This repo has simplified a few of the Sequelize CLI options that would be common
 - `npm run db-create` will create the database and run all migrations.
 - `npm run db-delete` will delete all tables and revert all migrations.
 - `npm run db-seed` will run all seeders and populate all data.
-- `npm run db-unseed` will delete all data in all tables and revert all seeders.
+- `npm run db-unseed` will delete all data in all tables and revert all seeders.
+
+# Links and more information
+To create new models, migrations, and seeders you _must_ use the Sequelize CLI commands. Full documentation is here https://sequelize.org/master/manual/migrations.html but here are a few useful commands:
+- `npx sequelize-cli model:generate --name User --attributes firstName:string,lastName:string,email:string` - Creates a model under `/src/models` and a migration script.
+- `npx sequelize-cli seed:generate --name demo-user` - Creates a seeder for the `User` model and migration previously setup.