Skip to content

setup.md

Latest commit

 

History

History
127 lines (88 loc) · 3.09 KB

setup.md

File metadata and controls

127 lines (88 loc) · 3.09 KB

Setting up

Clone the repo

$ git clone https://github.com/hack4impact/flask-base.git
$ cd flask-base

Initialize a virtualenv

$ pip install virtualenv
$ virtualenv -p /path/to/python3.x/installation env
$ source env/bin/activate

For mac users it will most likely be

$ pip install virtualenv
$ virtualenv -p python3 env
$ source env/bin/activate

Note: if you are using a python2.x version, point the -p value towards your python2.x path

(If you're on a mac) Make sure xcode tools are installed

$ xcode-select --install

Add Environment Variables

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.txt

Other dependencies for running locally

You need Redis, and Sass. Chances are, these commands will work:

Sass:

$ gem install sass

Redis:

Mac (using homebrew):

$ brew install redis

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):

sudo apt-get install libpq-dev

Create the database

$ python manage.py recreate_db

Other setup (e.g. creating roles in database)

$ python manage.py setup_dev

Note that this will create an admin user with email and password specified by the ADMIN_EMAIL and ADMIN_PASSWORD config variables. If not specified, they are both flask-base-admin@example.com and password respectively.

[Optional] Add fake data to the database

$ python manage.py add_fake_data

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.