oilus19/flask-boilerplate

The code I use to get a new client project up and running quickly.

Actual readme for this project:

To make this template fit your app, replace the following

• {{APP_NAME}} -> App Name
• {{APP_SLUG}} -> app-name
• {{APP_BLURB}} -> Here is a quick blurb about the app

TODO:

• emailing
• redis caching

=====================

{{APP_NAME}}

{{APP_BLURB}}

Install python dependencies

This project assumes you already have virtualenv, virtualenvwrapper and autoenv installed globally on your system.

First, create a new virtual environment:

mkvirtualenv {{APP_SLUG}}

Then, install the required python dependencies

pip install -r requirements.txt

Setup local postgres database

Create the database locally

psql -h localhost -d postgres

psql (9.4.4)
Type "help" for help.

postgres=# CREATE DATABASE {{APP_SLUG}};
CREATE DATABASE

Run your local server

Ensure that the local .env file has been applied, then run

python app.py

or alternatively, use gunicorn

gunicorn app:app --reload --bind 127.0.0.1:5000

Run database migrations

Detect changes to models.py and generate a timestamped migration file

python manage.py db migrate

Once you've looked over the generated migrations file, apply the migration to your local database

python manage.py db upgrade

Testing

You'll need to set up a separate postgres database for testing

psql -h localhost -d postgres

psql (9.4.4)
Type "help" for help.

postgres=# CREATE DATABASE {{APP_SLUG}}_test;
CREATE DATABASE

To run the tests

python test.py

Deploying

To push code changes to heroku

git push heroku master

To run database migrations on heroku

heroku run python manage.py db upgrade

Make sure you run this immediately after deploying any code that includes database migrations.