Flask application generator for boosting your development.
Project description
Flask application generator for boosting your development.
Installation
pip install git+https://github.com/hustlzp/Flask-Boost.git@fis#egg=flask_boost
ATTENTION: Breaking changes have been made in 0.6.0, use the command below if you want to install the 0.5.6 version:
pip install flask-boost==0.5.6
Development Guide
Init project
boost new <your_project_name>
Install 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 gulp
cd to project root path, run:
virtualenv venv . venv/bin/activate pip install -r requirements.txt npm install bower install
Init database
Create database with name your_project_name.
Update SQLALCHEMY_DATABASE_URI in config/development.py as needed.
Then init tables:
python manage.py db upgrade
Run Gulp watch task
gulp watch
Run app
Run local server:
python manage.py run
LiveReload support
Install livereload browser extension from here.
Run livereload server in another console:
python manage.py live
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.
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.
Int Language & Frameworks -> JavaScript -> Bower, set bower.json as bower.json.
Recommended PyCharm plugins:
.ignore
Markdown
Bootstrap3
First Production Deploy
Config server
Install virtualenv, git, supervisor and g++ on your server.
Note: Flask-Boost uses Pillow to process images, so you may install some external libraries needed by Pillow. Please follow the Pillow official doc.
Install requirements
git clone **.git cd proj virtualenv venv . venv/bin/activate pip install -r requirements.txt
Config app
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 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
for CentOS 7:
systemctl start nginx.service systemctl start supervisord.service
Daily Production Deploy
Update HOST_STRING in config with the format user@ip.
Commit your codes and run:
git push && fab deploy
License
The MIT License (MIT)
Copyright (c) 2015 hustlzp
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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.