docs/index.md
# Welcome to Flask-Base Documentation
## Source Code
See [the Github repository](http://github.com/hack4impact/flask-base)
## Purpose
This guide is meant to be a mix between formal and explanatory documentation.
## Synopsis
A Flask application template with the boilerplate code already done for you.
## What's included?
* Blueprints
* User and permissions management
* Flask-SQLAlchemy for databases
* Flask-WTF for forms
* Flask-Assets for asset management and SCSS compilation
* Flask-Mail for sending emails
* gzip compression
* gulp autoreload for quick static page debugging
## Formatting code
Before you submit changes to flask-base, you may want to auto format your code with `python manage.py format`.
## Contributing
See [the Github repository](http://github.com/hack4impact/flask-base)
## License
[MIT License](http://github.com/hack4impact/flask-base/blob/master/LICENSE.md)