Flask Skeleton

Flask starter project...

Quick Start

Basics

1. Create and activate a virtualenv
2. Install the requirements

Cookiecutter Template

Install cookiecutter with your package manager:

$ pip install cookiecutter

Create your app with:

$ cookiecutter https://github.com/vuLgAr/flask-skeleton.git --checkout cookiecutter

Set Environment Variables

Update project/server/config.py, and then run:

$ export APP_NAME="Flask Skeleton"
$ export APP_SETTINGS="project.server.config.DevelopmentConfig"
$ export FLASK_DEBUG=1

Using pipenv or python-dotenv? Use the .env file to set environment variables:

APP_NAME="Flask Skeleton"
APP_SETTINGS="project.server.config.DevelopmentConfig"
FLASK_DEBUG=1

Create DB

$ python manage.py create_db
$ python manage.py db init
$ python manage.py db migrate
$ python manage.py create_admin
$ python manage.py create_data

Run the Application

$ python manage.py run

Access the application at the address http://localhost:5000/

Testing

Without coverage:

$ python manage.py test

With coverage:

$ python manage.py cov