INTRODUCTION
Fbone (Flask bone) is a Flask (Python microframework) template/bootstrap/boilerplate application, with best practices (I hope).
You can use it for
- learning Flask.
- kicking off your new project.
COMPONENTS
Frontend
Flask Extensions
Others
- Modular Applications with Blueprints.
- Use Sentry for real-time crash reporting.
- Automated managament via fabric
USAGE
Pre-required Setup:
-
MacOS/Ubuntu (should be fine in other linux distro)
-
git
-
Python / pip / Fabric
-
sqlite / MySQL
-
Apache + mod_wsgi
git clone https://github.com/imwilsonxu/fbone.git fbone
fab setup_python_macos fab bootstrap fab test fab debug
STRUCTURE
โโโ CHANGES Change logs
โโโ README.markdown
โโโ fabfile.py Fabric file to automated managament project
โโโ fbone.conf Apache config
โโโ requirements.txt 3rd libraries
โโโ tests.py Unittests
โโโ wsgi.py Wsgi app
โโโ fbone
ย ย โโโ __init__.py
ย ย โโโ app.py Main App
ย ย โโโ config.py Develop / Testing configs
ย ย โโโ constants.py Constants
ย ย โโโ decorators.py Customized decorators
ย ย โโโ extensions.py Flask extensions
ย ย โโโ filters.py Flask filters
ย ย โโโ utils.py Python utils
ย ย โโโ frontend Frontend blueprint
ย ย โย ย โโโ __init__.py
ย ย โย ย โโโ forms.py Forms used in frontend modular
ย ย โย ย โโโ views.py Views used in frontend modular
ย ย โโโ user
ย ย โโโ api
ย ย โโโ static Static files
ย ย โย ย โโโ css
ย ย โย ย โโโ favicon.png
ย ย โย ย โโโ humans.txt
ย ย โย ย โโโ img
ย ย โย ย โโโ js
ย ย โย ย โโโ robots.txt
ย ย โโโ templates Jinja2 templates
ย ย ย ย โโโ errors
ย ย ย ย โโโ frontend
ย ย ย ย โโโ index.html
ย ย ย ย โโโ layouts Jinja2 layouts
ย ย ย ย โย ย โโโ base.html
ย ย ย ย โย ย โโโ user.html
ย ย ย ย โโโ macros Jinja2 macros
ย ย ย ย โโโ mails Mail templates
ย ย ย ย โโโ user
TODO
- Upgrade to Python3k.
- User Celery, distributed task queue.
- User Elastic Search, Open Source, Distributed, RESTful Search Engine.
- Use PostgreSQL.
- Use GeeTest, a popular CAPTCHA service in China.
LICENSE
ACKNOWLEDGEMENTS
Many thanks to Python, Flask and other good stacks.
