chrcoe/ccflasktest

testing cookiecutter-flask to see what I need to tweak if I want to use it as my base - I have found that it seems to be well built but I am trying to focus on the RESTful API only and not so much worried about the front end - I will work with another cookiecutter

Test CCFlask App

A flasky app.

Quickstart

First, set your app's secret key as an environment variable. For example, example add the following to .bashrc or .bash_profile.

export CCFLASKTEST_SECRET='something-really-secret'

Then run the following commands to bootstrap your environment.

git clone https://github.com/chrcoe/ccflasktest
cd ccflasktest
pip install -r requirements/dev.txt
python manage.py server

You will see a pretty welcome screen.

Once you have installed your DBMS, run the following to create your app's database tables and perform the initial migration:

python manage.py db init
python manage.py db migrate
python manage.py db upgrade
python manage.py server

Deployment

In your production environment, make sure the CCFLASKTEST_ENV environment variable is set to "prod".

Shell

To open the interactive shell, run

python manage.py shell

By default, you will have access to app, db, and the User model.

Running Tests

To run all tests, run

python manage.py test

Migrations

Whenever a database migration needs to be made. Run the following commands:

python manage.py db migrate

This will generate a new migration script. Then run:

python manage.py db upgrade

To apply the migration.

For a full migration command reference, run python manage.py db --help.