Commit a9d173ce0d8a1d3cd401111ed4b55e23aa1c4c81
1 parent
be49e073
Exists in
master
Add a bare-bones README file.
The setup is still pretty complicated :(
Showing
1 changed file
with
30 additions
and
0 deletions
Show diff stats
| @@ -0,0 +1,30 @@ | @@ -0,0 +1,30 @@ | ||
| 1 | + | ||
| 2 | +# Travel Carbon Footprint Calculator | ||
| 3 | + | ||
| 4 | + | ||
| 5 | +## Installation | ||
| 6 | + | ||
| 7 | + virtualenv venv | ||
| 8 | + source venv/bin/activate | ||
| 9 | + pip install -r requirements.txt | ||
| 10 | + python manage.py createdb | ||
| 11 | + | ||
| 12 | + | ||
| 13 | +## Development | ||
| 14 | + | ||
| 15 | + source venv/bin/activate | ||
| 16 | + export FLASK_APP=flaskr | ||
| 17 | + export FLASK_ENV=development | ||
| 18 | + export FLASK_RUN_EXTRA_FILES="content.yml" | ||
| 19 | + flask run | ||
| 20 | + | ||
| 21 | +Then, visit http://localhost:5000 | ||
| 22 | + | ||
| 23 | +> We're trying to remove the need for the `export` statements, but… | ||
| 24 | + | ||
| 25 | + | ||
| 26 | +## Overview | ||
| 27 | + | ||
| 28 | +Content is in `content.yml`. | ||
| 29 | +HTML templates are in `flaskr/templates`. | ||
| 30 | +Controllers are in `flaskr/controllers`. |