https://github.com/brijeshb42/flask-web-starter-kit

Flask application with complete integration of gulp build system
https://github.com/brijeshb42/flask-web-starter-kit

Last synced: about 2 months ago
JSON representation

Flask application with complete integration of gulp build system

• Host: GitHub
• URL: https://github.com/brijeshb42/flask-web-starter-kit
• Owner: brijeshb42
• Created: 2015-05-27T05:33:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-07-06T07:24:20.000Z (over 9 years ago)
• Last Synced: 2023-05-11T12:05:15.266Z (over 1 year ago)
• Language: HTML
• Homepage:
• Size: 152 KB
• Stars: 10
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Flask Starter Kit

### Comes with preconfigured basic Flask app with SQLAlchmemy, LoginForm, Basic User Model, and static assets.

### Requirements:

* Python 2.7.x

* `node` with global installation of `gulp` and `bower`. Can be used without that global installations also.

### How to use ?

* Clone this repo `git clone [email protected]:brijeshb42/flask-web-starter-kit.git`.

* Create a new virtual environment `mkvirtualenv starter-kit`.

* Switch to the new env `workon starter-kit`.

* Install python modules `pip install -r requirements.txt`.

* Install node modules to compile assets `npm install`.

* Install bower packages `bower install`.

* Copy `config.py.default` to `config.py`.

* Make changes to `config.py` as required.

* Create a symlink to `bower_components` folder inside `frontend` : `cd frontend && ln -s ../bower_components/ bower_components`.

* Migrate DB (uses sqlite by default. Can be configured in `config.py`)

    * `python script.py db init`

    * `python script.py db migrate`

    * `python script.py db upgrade`

* In separate terminal, `cd` into the `starter-kit` directory and run `gulp clean && gulp` to compile static assets and start a livereload server.

* Then run `python script.py runserver`

* Open `localhost:5000` in browser.

* To add your own routes, open `backend/app.py` and start adding your own urls and responses. You can spin off your routes in new files. Just don't forget to import your files in `app.py`.