README.md 1.13 KB

Travel Carbon Footprint Calculator

Overview

  • Content is in content.yml.
  • Configuration is in content.yml.
  • HTML templates are in flaskr/templates.
  • Estimation Models are in flaskr/laws.
  • Controllers are in flaskr/controllers.

Installation

Tested only on Python 2.7. Sprint.

Create a virtual environment

You don't have to. But it's useful for development.

virtualenv venv

Then, source it to enable it.

source venv/bin/activate

Install the python dependencies

pip install -r requirements.txt

Create an empty database

python manage.py createdb

Configure the secrets

cp .env.dist .env
nano .env

Development

source venv/bin/activate
export FLASK_APP=flaskr
export FLASK_ENV=development
export FLASK_RUN_EXTRA_FILES="content.yml"
flask run

Then, visit http://localhost:5000

We're trying to remove the need for the export statements, but…

Build CSS and JS for prod

flask assets build