README.md

Flask in a Can

1. Clone repo:

   $ git clone git://github.com/jvsteiner/flask-in-a-can.git

2. Change directory:

   $ cd flask-in-a-can

3. Install dependencies: instructions for virtualenv not included - you are using virtualenv, right?

   $ pip install -r requirements.txt

4. Copy the example email config and edit the values, use env.py in production to override development settings: If you use a capistrano style deployment technique like fabistrano, you will need to put the env/ tmp/ and static/ directories in the shared directory structure.

   $ cp env/email.py.example env/email.py

   $ cp env/env.py.example env/env.py

5. Initialize, migrate and upgrade the database:

   $ python app.py db migrate

   $ python app.py db upgrade

6. Start the app:

   $ python app.py runserver

NOTE: layout.html uses a _scripts.html helper that references several javascript libraries that I like to use:

twitter bootstrap 3.2.0

jquery 1.8.2

knockout.js 2.2.1

knockout mapping plugin 2.4.1

The helper is set to use a CDN link when config.PRODUCTION == True, and serve from /static otherwise. You will need to obtain local copies to work offline in development mode (or change config.PRODUCTION = False and work online).

$ chmod u+x getjs.sh 

$ ./getjs.sh

This project includes templates for registration, signin, password reset, password change, and user profile I based it off mattupstate/flask-security-example, and added some other functionality that I commonly use. Hope you find it helpful.

To create an initial user, populate the config/email.py with working smtp details, then signup. use the admin interface at localhost:5000/admin to add an admin role, and grant it to your user. You can then swap out the is_accessible definitions in the admin views to prevent non-admin users from acessing the admin interface.

Uses sqlite out of the can, but you can easily substitute your db backend of choice.