A flasky app.

This project uses pipenv to manage requirements.

From the pipenv project readme:

Pipenv — the officially recommended Python packaging tool from Python.org, free (as in freedom).

Pipenv is a tool that aims to bring the best of all packaging worlds (bundler, composer, npm, cargo, yarn, etc.) to the Python world. Windows is a first–class citizen, in our world.

It automatically creates and manages a virtualenv for your projects, as well as adds/removes packages from your Pipfile as you install/uninstall packages. It also generates the ever–important Pipfile.lock, which is used to produce deterministic builds.

Install with pip

pip install pipenv

Run the following commands to setup your environment :

git clone https://github.com/austinmcconnell/myflaskapp
cd myflaskapp
pipenv install --dev
npm install
npm start  # run the webpack dev server and flask server using concurrently

You will see a pretty welcome screen here

Generate a secret key by opening up a python shell and running this code:

import secrets
secrets.token_hex(20)

Take the token from above and place it in a .env file along with the following information:

# Flask
FLASK_APP=autoapp.py
FLASK_DEBUG=1
MYFLASKAPP_SECRET = secret_token_from_above

# Node
NODE_ENV=development
NPM_CONFIG_PRODUCTION=false

This uses a sqlite database by default for local development. If you would like to setup something more powerful (or that matches your production setup), add the following section to your .env file:

# Database
DB_USERNAME=username
DB_PASSWORD=password
DB_HOST=host
DB_NAME=port

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

flask db init
flask db migrate
flask db upgrade

If this project repo is on GitHub, you can automatically deploy to Heroku using this button. All you need to do is fill in an app name on the deployment screen.

brew install heroku

You only need to do this once.

heroku login

heroku create My Flask App

Note: you can leave the project name off and just use heroku create and you'll get a randomly named app.

heroku config:set NODE_ENV=development NPM_CONFIG_PRODUCTION=false

This will tell Heroku to install all devDependencies as well as the dependencies in your package.json file.

heroku config:set FLASK_APP=autoapp.py FLASK_DEBUG=0

This sets the pertinent Flask env variables on your heroku dyno.

If you intend to use webpack to build your static assets on deploy to Heroku, make sure the following line is added to your package.json file under scripts

    "postinstall": "npm run build"

Example

  "scripts": {
    "build": "NODE_ENV=production webpack --progress --colors -p",
    "start": "concurrently -n \"WEBPACK,FLASK\" -c \"bgBlue.bold,bgMagenta.bold\" \"npm run webpack-dev-server\" \"npm run flask-server\"",
    "webpack-dev-server": "NODE_ENV=debug webpack-dev-server --port 2992 --hot --inline",
    "flask-server": "FLASK_APP=$PWD/autoapp.py FLASK_DEBUG=1 flask run",
    "lint": "eslint \"assets/js/*.js\"",
    "postinstall": "npm run build"
  }

git push heroku master

TODO: Fill in instructions.

heroku addons:create heroku-postgresql:hobby-dev

hobby-dev is a free postgres instance limited to 10,000 rows.

Signup for a free account at Rollbar

heroku addons:create rollbar
heroku addons:open rollbar

Optionally Set up Github integration and Deploy hooks

To open the interactive shell, run :

flask shell

By default, you will have access to the flask app.

To run all tests, run :

flask test

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

flask db migrate

This will generate a new migration script. Then run :

flask db upgrade

To apply the migration.

For a full migration command reference, run flask db --help.

Files placed inside the assets directory and its subdirectories (excluding js and css) will be copied by webpack's file-loader into the static/build directory, with hashes of their contents appended to their names. For instance, if you have the file assets/img/favicon.ico, this will get copied into something like static/build/img/favicon.fec40b1d14528bf9179da3b6b78079ad.ico. You can then put this line into your header:

<link rel="shortcut icon" href="{{asset_url_for('img/favicon.ico') }}">

to refer to it inside your HTML page. If all of your static files are managed this way, then their filenames will change whenever their contents do, and you can ask Flask to tell web browsers that they should cache all your assets forever by including the following line in your settings.py:

SEND_FILE_MAX_AGE_DEFAULT = 31556926  # one year