Forked Flask-Boost - Flask application generator for boosting your development.
Project description
Flask application generator for boosting your development.
Features
Well Defined Project Structure
Use factory pattern to generate Flask app.
Use Blueprints to organize controllers.
Split controllers, models, forms, utilities, assets, Jinja2 pages, Jinja2 macros into different directories.
Organize Jinja2 page assets (HTML, JavaScript, CSS) to the same directory.
Organize Jinja2 macro assets (HTML, JavaScript, CSS) to the same directory.
Batteries Included
Use Flask-SQLAlchemy and Flask-Migrate as database tools.
Use Flask-WTF to validate forms.
Use Flask-Script to help writing scripts.
Use Flask-Security for user management.
Use Flask-OAuthlib for social user authentication.
Use Bulma as frontend framework.
Use Gunicorn to run Flask app and Supervisor to manage Gunicorn processes.
Use Fabric as deployment tool.
Use Sentry to log exceptions.
Use Nginx to serve static files.
Use sub script command to generate admin and form from a model.
Scaffold Commands
Generate project files: turbo new <project>
Generate controller files: turbo new controller <controller>
Generate action files: turbo new action <controller> <action> [-t]
Generate form files: turbo new form <form>
Generate model files: turbo new model <model>
Generate macro files: turbo new macro <category> <macro> or boost new macro <macro>
Installation
pip install flask-turbo-boost
Development Guide
Init project
turbo new <your_project_name>
Setup backend requirements
cd <your_project_dir> virtualenv venv . venv/bin/activate (venv\Scripts\activate in Windows) pip install -r requirements.txt
Note: if you failed in pip install -r requirements.txt in Windows, try to install package binaries directly:
pycrpyto: try to follow this article compiling-pycrypto-on-win7-64, or get the complied pycrypyto library directly: archive_pycrpyto_library.
Init database
Create database with name your_project_name and encoding utf8.
Update SQLALCHEMY_DATABASE_URI in config/development.py as needed.
Then init tables:
python manage.py db upgrade
Run app
Run local server:
python manage.py run
Setup frontend requirements
Install Node.js first and then install Bower, FIS and Gulp globally:
npm install -g bower npm install -g fis npm install -g fis-postpackager-simple npm install -g gulp
Install local packages:
npm install bower install
Run Gulp watch task
gulp watch
LiveReload support
Install LiveReload browser extension from here.
And use python manage.py live instead of python manage.py run to start app.
Scaffold commands
boost new <project> boost new controller <controller> boost new action <controller> <action> [-t] boost new form <form> boost new model <model> boost new macro <category> <macro> boost new macro <macro> boost -v boost -h
Recommended IDE
PyCharm is the recommended IDE for Flask-Boost.
Recommended preferences:
In Preferences -> Project -> Project Interpreter, set venv as project interpreter.
In Preferences -> Project -> Project Structure, set application/pages and application/macros as template folders, set application and application/static/css as resource folders.
In Language & Frameworks -> JavaScript -> Bower, set bower.json as bower.json.
Recommended PyCharm plugins:
.ignore
Markdown
Bootstrap3
First Production Deploy
Config server
Install mysql-server, python-virtualenv, git, supervisor, nginx, g++, python-dev, libmysqlclient-dev, libxml2-dev, libxslt-dev on your server.
Install requirements
git clone **.git cd <your_project_dir> virtualenv venv . venv/bin/activate pip install -r requirements.txt
Config app
Save config/production_sample.py as config/production.py, update configs in config/production.py as needed and transfer it to server.
Note: remember to update SECRET_KEY in config/production.py! You can generate random secret key as follows:
>>> import os >>> os.urandom(24)
Init database
Create database with name your_project_name and encoding utf8.
And run:
export MODE=PRODUCTION python manage.py db upgrade
Copy config files
Update project root path as needed in deploy/nginx.conf and deploy/supervisor.conf.
cp deploy/flask_env.sh /etc/profile.d/ cp deploy/nginx.conf /etc/nginx/conf.d/<your_project_name>.conf cp deploy/supervisor.conf /etc/supervisor/conf.d/<your_project_name>.conf
Build assets
Install Node.js first and then install Bower, FIS and Gulp globally:
npm install -g bower npm install -g fis npm install -g fis-postpackager-simple npm install -g gulp
Install local packages:
npm install bower install
Then:
gulp python manage.py build
Start app
service nginx restart service supervisor restart
Daily Production Deploy
Update HOST_STRING in config with the format user@ip.
Commit your codes and run:
git push && fab deploy
P.S. If you wanna to deploy flask with Apache2, see this post.
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.