Merge pull request hack4impact#170 from ozbek/docs

Update setup docs

Author: abhisuri97

docs/setup.md

@@ -29,38 +29,74 @@ Note: if you are using a python2.x version, point the -p value towards your pyth
 $ xcode-select --install
 ```
 
-## Add Environment Variables 
+## Add Environment Variables
 
-Create a file called `.env` that contains environment variables in the following syntax: `ENVIRONMENT_VARIABLE=value`. For example,
-the mailing environment variables can be set as the following
+Create a file called `config.env` that contains environment variables in the following syntax: `ENVIRONMENT_VARIABLE=value`.
+You may also wrap values in double quotes like `ENVIRONMENT_VARIABLE="value with spaces"`.
+For example, the mailing environment variables can be set as the following.
+We recommend using Sendgrid for a mailing SMTP server, but anything else will work as well.
 ```
 MAIL_USERNAME=example@domain.com
 MAIL_PASSWORD=SuperSecretPassword
 SECRET_KEY=SuperRandomStringToBeUsedForEncryption
 ```
+
+Other Key value pairs:
+
+* `ADMIN_EMAIL`: set to the default email for your first admin account (default is `flask-base-admin@example.com`)
+* `ADMIN_PASSWORD`: set to the default password for your first admin account (default is `password`)
+* `DATABASE_URL`: set to a postgresql database url (default is `data-dev.sqlite`)
+* `REDISTOGO_URL`: set to Redis To Go URL or any redis server url (default is `http://localhost:6379`)
+* `RAYGUN_APIKEY`: api key for raygun (default is `None`)
+* `FLASK_CONFIG`: can be `development`, `production`, `default`, `heroku`, `unix`, or `testing`. Most of the time you will use `development` or `production`.
+
 **Note: do not include the `.env` file in any commits. This should remain private.**
 
 ## Install the dependencies
 
 ```
-$ pip install -r requirements/common.txt
-$ pip install -r requirements/dev.txt
+$ pip install -r requirements.txt
 ```
 
 ## Other dependencies for running locally
 
-Mac (using [homebrew](http://brew.sh/)):
+You need [Redis](http://redis.io/), and [Sass](http://sass-lang.com/). Chances are, these commands will work:
+
+
+**Sass:**
+
+```
+$ gem install sass
+```
+
+**Redis:**
+
+_Mac (using [homebrew](http://brew.sh/)):_
 
 ```
 $ brew install redis
 ```
 
-Linux:
+_Linux:_
 
 ```
 $ sudo apt-get install redis-server
 ```
 
+You will also need to install **PostgresQL**
+
+_Mac (using homebrew):_
+
+```
+brew install postgresql
+```
+
+_Linux (based on this [issue](https://github.com/hack4impact/flask-base/issues/96)):_
+
+```
+sudo apt-get install libpq-dev
+```
+
 ## Create the database
 
 ```
@@ -81,17 +117,11 @@ Note that this will create an admin user with email and password specified by th
 $ python manage.py add_fake_data
 ```
 
-## [Optional. Only valid on `gulp-static-watcher` branch] Use gulp to live compile your files
-
-* Install the Live Reload browser plugin from [here](http://livereload.com/)
-* Run `npm install`
-* Run `gulp`
-
-
 ## Running the app
 
 ```
 $ source env/bin/activate
 $ honcho start -f Local
 ```
 
+For Windows users having issues with binding to a redis port locally, refer to [this issue](https://github.com/hack4impact/flask-base/issues/132).