Flask on Fire

A MVC template for Flask

Setup

Run

• only support python3
• setup virtualenv python3 -m virtualenv .venv
• activate vevn source .venv/bin/activate
• install requirements pip install -r requirements.txt
• rename config/database.yml.default to config/database.yml
• use bin/fire server to setup a development server

Settings

• use config/routes.yml to register routes
• change config/config.yml accordingly
• write static files in public/
• change static file bundle settings in app/assets.py
• use app/jobs.py to setup aync jobs using rq (redis queue)
• change path in fire.supervisor.conf
• use supervisord and uwsgi to setup production server

RQ Workers

(.venv) $ .venv/bin/rq worker --url redis://127.0.0.1:6379/0 --name rq_worker_name  high normal low

Commands

(.venv) $ bin/fire 
Usage: fire [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  console  Open a test console with flask context
  new      Create a new app/scaffold
  routes   List all routes
  server   Run a development fire server.

(.venv) $ bin/fire new
Usage: fire new [OPTIONS] [app|scaffold] APP_NAME
Try "fire new --help" for help.

Error: Missing argument "[app|scaffold]".  Choose from:
	app,
	scaffold.

(.venv) $ bin/fire new app test
Creating folder app/test ...
Creating file controllers.py ...
Writing into file controllers.py...
Creating file __init__.py ...
Creating folder app/test/templates/test ...

(.venv) $ bin/fire new scaffold test
Creating folder app/test ...
Creating file controllers.py ...
Writing into file controllers.py...
Creating file __init__.py ...
Creating folder app/test/templates/test ...
Creating templates files in app/test/templates/test ...
Writing scaffold routes into config/routes.yml ...

Contributor

Thanks for awesome projects

• CharlyJazz/Flask-MVC-Template
• sloria/flask-konch
• Fire is first used by @sooooner11 in DARPA project minty

License

Flask on Fire is released under the MIT License.