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.
