aleanza / notejam_flask

Notejam: Flask

Notejam application implemented using Flask microframework.

Flask version: 0.9

Flask extension used:

• Flask-Login
• Flask-Mail
• Flask-SQLAlchemy
• Flask-Testing
• Flask-WTF

Installation and launching

Clone

Clone the repo:

$ git clone [email protected]:komarserjio/notejam.git YOUR_PROJECT_DIR/

Install

Use virtualenv or virtualenvwrapper for environment management.

Install dependencies:

$ cd YOUR_PROJECT_DIR/flask/
$ pip install -r requirements.txt

Launch

Start flask web server:

$ cd YOUR_PROJECT_DIR/flask/
$ python runserver.py

Go to http://127.0.0.1:5000/ in your browser.

If you do like that, all data added will be stored in a in-memory SQLite database. If you want to keep the state, export the environment variable ENVIRONMENT:

In a single line:

$ ENVIRONMENT=development python runserver.py

Run tests

Run functional and unit tests:

$ cd YOUR_PROJECT_DIR/flask/
$ python tests.py

Contribution

Do you have python/flask experience? Help the app to follow Python and Flask best practices.

Please send your pull requests in the master branch. Always prepend your commits with framework name:

Flask: Implemented sign in functionality

Read contribution guide for details.