Merge pull request #196 from dod-ccpo/update-readme

Update README with better setup instructions

README.md

@@ -8,15 +8,36 @@ This is the user-facing web application for ATAT.
 
 ## Installation
 
-### Requirements
+### System Requirements
-See the [scriptz](https://github.com/dod-ccpo/scriptz) repository for the shared
+ATST uses the [Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all)
-requirements and guidelines for all ATAT applications.
+pattern for setting up and running the project. The scripts are located in the
+`scripts` directory and use script fragments in the
+[scriptz](https://github.com/dod-ccpo/scriptz) repository that are shared across
+ATAT repositories.
 
-ATST requires a postgres instance (>= 9.6) for persistence. Have postgres installed
+Before running the setup scripts, a couple of dependencies need to be installed
-and running on the default port of 5432.
+locally:
 
-ATST also requires a redis instance for session management. Have redis installed and
+* `python` == 3.6
-running on the default port of 6379.
+  Python version 3.6 must be installed on your machine before installing `pipenv`.
+  You can download Python 3.6 [from python.org](https://www.python.org/downloads/)
+  or use your preferred system package manager.
+
+* `pipenv`
+  ATST requires `pipenv` to be installed for python dependency management. `pipenv`
+  will create the virtual environment that the app requires. [See
+  `pipenv`'s documentation for instructions on installing `pipenv](
+  https://pipenv.readthedocs.io/en/latest/install/#installing-pipenv).
+
+* `postgres` >= 9.6
+  ATST requires a PostgreSQL instance (>= 9.6) for persistence. Have PostgresSQL installed
+  and running on the default port of 5432. You can verify that PostgresSQL is running
+  by executing `psql` and ensuring that a connection is successfully made.
+
+* `redis`
+  ATST also requires a Redis instance for session management. Have Redis installed and
+  running on the default port of 6379. You can ensure that Redis is running by
+  executing `redis-cli` with no options and ensuring a connection is succesfully made.
 
 ### Cloning
 This project contains git submodules. Here is an example clone command that will
@@ -62,6 +83,10 @@ To watch for changes to any js/css assets:
 
     yarn watch
 
+After running `script/dev_server`, the application is available at
+[`http://localhost:8000`](http://localhost:8000).
+
+
 ### Users
 
 There are currently six mock users for development:
@@ -73,7 +98,11 @@ There are currently six mock users for development:
 - Dominick
 - Erica
 
-To log in as one of them, navigate to `/login-dev?username=<lowercase name>`. For example `/login-dev?username=amanda`.
+To log in as one of them, navigate to `/login-dev?username=<lowercase name>`.
+For example `/login-dev?username=amanda`.
+
+In development mode, there is a `DEV Login` button available on the home page
+that will automatically log you in as Amanda.
 
 ## Testing