Adding instructions.

README.md

@@ -1,53 +1,98 @@
-# README Template
-
-Below is a template provided for use when building your README file for students.
-
 # Give your Application Auto-Deploy Superpowers
 
-Project description goes here.
+In this project, you will prove your mastery of the following learning objectives:
+
+- Explain the fundamentals and benefits of CI/CD to achieve, build, and deploy automation for cloud-based software products.
+- Utilize Deployment Strategies to design and build CI/CD pipelines that support Continuous Delivery processes.
+- Utilize a configuration management tool to accomplish deployment to cloud-based servers.
+- Surface critical server errors for diagnosis using centralized structured logging.
 
 ## Getting Started
 
 Instructions for how to get a copy of the project running on your local machine.
 
 ### Dependencies
 
+NodeJs v10 or higher
+
+### Installation
+
+This is a "mono-repository" which means multiple servers or layers exist in the same repository. You'll find the following main folders:
+
+- `./frontend`
+- `./backend`
+
+#### 1. Install dependencies in both front-end and back-end folders.
+
 ```
-Examples here
+cd frontend
+npm i
 ```
 
-### Installation
+```
+cd backend
+npm i
+```
 
-Step by step explanation of how to get a dev environment running.
+#### 2. Create `.env` file for database connection info.
 
-List out the steps
+Add a `.env` file to your `backend` folder with the following contents:
 
 ```
-Give an example here
+NODE_ENV=local
+VERSION=1
+TYPEORM_CONNECTION=postgres
+TYPEORM_MIGRATIONS_DIR=./src/migrations
+TYPEORM_ENTITIES=./src/modules/domain/**/*.entity.ts
+TYPEORM_MIGRATIONS=./src/migrations/*.ts
+
+# Things you can change if you wish...
+TYPEORM_HOST=localhost
+TYPEORM_PORT=5532
+TYPEORM_USERNAME=postgres
+TYPEORM_PASSWORD=password
+TYPEORM_DATABASE=glee
 ```
 
-## Testing
+You can use your own Postgres server if you wish or you can use the Docker-Compose template we provided in the `./utils` folder.
+
+## Running PostgreSQL in Docker-Compose
+
+For convenience, we have provided a template that you can use to easily run a Postgres database for local testing. To run this template, you'll need to install Docker and Docker-Compose.
+
+To start the database:
+
+```
+cd utils
+docker-compose up
+```
 
-Explain the steps needed to run any automated tests
+## Testing
 
-### Break Down Tests
+We have provided unit tests for both back-end and front-end.
 
-Explain what each test does and why
+```
+cd frontend
+npm run test
+```
 
 ```
-Examples here
+cd backend
+npm run test
 ```
+
 ## Project Instructions
 
 This section should contain all the student deliverables for this project.
 
 ## Built With
 
-* [Item1](www.item1.com) - Description of item
-* [Item2](www.item2.com) - Description of item
-* [Item3](www.item3.com) - Description of item
+- [Item1](www.item1.com) - Description of item
+- [Item2](www.item2.com) - Description of item
+- [Item3](www.item3.com) - Description of item
 
 Include all items used to build project.
 
 ## License
+
 [License](LICENSE.md)

backend/development.env

@@ -5,37 +5,9 @@ TYPEORM_MIGRATIONS_DIR=./src/migrations
 TYPEORM_ENTITIES=./src/modules/domain/**/*.entity.ts
 TYPEORM_MIGRATIONS=./src/migrations/*.ts
 
+# Things you can change if you wish...
 TYPEORM_HOST=localhost
-TYPEORM_PORT=5432
+TYPEORM_PORT=5532
 TYPEORM_USERNAME=postgres
 TYPEORM_PASSWORD=password
-TYPEORM_DATABASE=glee   
-
-#TYPEORM_HOST=gleestag.c0xjitcfqke4.us-east-1.rds.amazonaws.com
-#TYPEORM_PORT=5432
-#TYPEORM_USERNAME=acklen
-#TYPEORM_PASSWORD=acklenavenue
-#TYPEORM_DATABASE=gleedev
-
-#TYPEORM_HOST=gleedev.c0xjitcfqke4.us-east-1.rds.amazonaws.com
-#TYPEORM_PORT=5432
-#TYPEORM_USERNAME=acklen
-#TYPEORM_PASSWORD=acklenavenue
-#TYPEORM_DATABASE=gleedev
-
-#TYPEORM_HOST=localhost
-#TYPEORM_PORT=3332
-#TYPEORM_USERNAME=acklen
-#TYPEORM_PASSWORD=acklenavenue
-#TYPEORM_DATABASE=gleestaging
-
-#TYPEORM_HOST=localhost
-#TYPEORM_PORT=3333
-#TYPEORM_USERNAME=acklen
-#TYPEORM_PASSWORD=acklenavenue
-#TYPEORM_DATABASE=gleeproduction
-
-AUTH0_CLIENT_SECRET=8j3P8a8ww9y5ZWg5whWJIE3V6zNu0btaBx9eSV3bR5Q3Tui7J8_fbc9j28x2BN1K
-AUTH0_CLIENT_ID=dipYe9GixcVztYazk2hqWXxwQcQK5Pxo
-AUTH0_DOMAIN=acklen.auth0.com
-AUTH0_AUDIENCE=http://localhost:3030
+TYPEORM_DATABASE=glee