Flask application generator for boosting your development.
pip install flask-boost
or install the latest version from GitHub:
pip install git+https://github.com/hustlzp/Flask-Boost.git#egg=flask_boost
ATTENTION: Breaking changes have been made in 0.6.x, use the command below if you want to install the 0.5.x version:
pip install flask-boost==0.5.6
boost new <your_project_name>
cd
to project root path, run:
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.
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 local server:
python manage.py run
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
Install local packages:
npm install
bower install
gulp watch
Install LiveReload browser extension from here.
And use python manage.py live
instead of python manage.py run
to start app.
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
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 plugins:
- .ignore
- Markdown
- Bootstrap3
Install virtualenv, git, supervisor, nginx 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.
git clone **.git
cd proj
virtualenv venv
. venv/bin/activate
pip install -r requirements.txt
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)
Create database with name your_project_name
and encoding utf8
.
And run:
export MODE=PRODUCTION
python manage.py db upgrade
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
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
service nginx restart
service supervisor restart
for CentOS 7:
systemctl start nginx.service
systemctl start supervisord.service
Update HOST_STRING
in config with the format user@ip
.
Commit your codes and run:
git push && fab deploy
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.