[readme update][s]: README updated with correct instructions. env.template updated to include correct ev variables - fixes #300

Author: zelima

README.md

@@ -37,22 +37,68 @@ $ psql -U postgres -c "create user dpr_user password 'secret' createdb;"
 $ psql -U postgres -c "create database dpr_db owner=dpr_user;"
 
 # create tables
-python manager.py db upgrade
+$ python manager.py createdb
+$ python manager.py populate
 ```
 
+While development, if you make changes to database structure, Eg: added new table,
+renamed column etc... You will have to **drop** all the tables and recreate them
+
+```
+$ python manager.py dropdb
+$ python manager.py createdb
+$ python manager.py populate
+```
+
+Note: Be careful! Doing so **all** of you data will be erased. **Never, ever** run
+`python manager.py dropdb` on production database like RDS or any other, unless you
+are super confident what are you doing!
+
 ### Environment Configuration
 
 Rename the env.template file to .env file and edit it.
 
-TODO: guidance about this including how to use the DB you created in the
-previous step.
+```
+JWT_SEED=<<Super Secret Key For Flask Sessions>>
+SQLALCHEMY_DATABASE_URI=<<Postgres Database URI>>*
+S3_BUCKET_NAME=<<AWS S3 Bucket Name For Data Storage>>
+AWS_ACCESS_KEY_ID= <<AWS Access Key>>
+AWS_SECRET_ACCESS_KEY= <<AWS Secret Access Key>>
+AWS_REGION= <<AWS Region >>
+GITHUB_CLIENT_ID= <<Github Client ID>>
+GITHUB_CLIENT_SECRET= <<Github Client Secret>>
+
+# For Deploy
+PROJECT= <<Project Name>>
+DOMAIN_BASE= <<Domain Base. Eg: example.com>>
+STAGE=<<Project Stage. Eg: dev>>
+DOMAIN=<<Full Domain. Eg: dev.example.com>>
+DPR_API_GIT=<<Git URL For Repo>>
+```
+
+For local development you can leave empty all variables except following ones:
+
+- SQLALCHEMY_DATABASE_URI
+- JWT_SEED
+- AWS_REGION
+- GITHUB_CLIENT_ID
+- GITHUB_CLIENT_SECRET
+
+You can use any string you like, Eg: "development", for all of them, except `SQLALCHEMY_DATABASE_URI`
+
+SQLALCHEMY_DATABASE_URI should follow the general form for a postgresq connection URI:
+`postgres://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]`
+
+If you created postgres database by following our instructions above, it should look like this:
+
+`SQLALCHEMY_DATABASE_URI=postgres://dpr_user:secret@localhost/dpr_db`
 
 ### Running locally
 
 You can now run the app locally! To do, run:
 
 ```
-python dpr.py
+$ python dpr.py
 ```
 
 ## Testing
@@ -66,21 +112,15 @@ $ export FLASK_CONFIGURATION=test
 This ensures that tests are not dependent on any env variable. By default it is dependent on
 local postgresql instance.
 
-TODO: explain how to set up this postgresql instance.
-
-We use pytest for testing. All tests are in tests directory. To run the tests do:
+You would want to create separate database for tests, for not loosing all the data
+from development database, you are working with.
 
 ```
-pytest tests
+$ psql -U postgres -c "create database dpr_test_db owner=dpr_user;"
 ```
 
-## Continuous deployment process
+We use pytest for testing. All tests are in tests directory. To run the tests do:
 
 ```
-git pull origin master
-git checkout deploy
-# if you do not yet have the deploy branch
-git checkout -b deploy
-git merge master
-git push origin deploy
+$ pytest tests
 ```

env.template

@@ -1,11 +1,15 @@
+SQLALCHEMY_DATABASE_URI=
+S3_BUCKET_NAME=
 AWS_ACCESS_KEY_ID=
 AWS_SECRET_ACCESS_KEY=
 AWS_REGION=
-AUTH0_CLIENT_ID=
-AUTH0_CLIENT_SECRET=
-AUTH0_DOMAIN=
-AUTH0_DB_NAME=
-AUTH0_API_AUDIENCE=
-S3_BUCKET_NAME=
-SQLALCHEMY_DATABASE_URI=
-JWT_SEED=
+GITHUB_CLIENT_ID=
+GITHUB_CLIENT_SECRET=
+JWT_SEED=
+
+# For Deploy
+PROJECT=
+DOMAIN_BASE=
+STAGE=
+DOMAIN=%(STAGE)s.%(DOMAIN_BASE)s
+DPR_API_GIT=