Skip to content

jefmud/Flask-Material-Lite

 
 

Repository files navigation

Flask-Material-Lite

A Flask starter project using Material Design Lite Template

Flask Project original initiated using cookiecutter-flask

Quickstart

First, set your app's secret key as an environment variable. For example, example add the following to .bashrc or .bash_profile.

export FLASKMDL_SECRET='something-really-secret'

Then run the following commands to bootstrap your environment.

git clone https://github.com/jimmyho/Flask-Material-Lite
cd flaskMDL
pip install -r requirements/dev.txt
python manage.py server

You will see a pretty welcome screen.

Once you have installed your DBMS, run the following to create your app's database tables and perform the initial migration:

python manage.py db init
python manage.py db migrate
python manage.py db upgrade
python manage.py server

Deployment

In your production environment, make sure the FLASKMDL_ENV environment variable is set to "prod".

Shell

To open the interactive shell, run

python manage.py shell

By default, you will have access to app, db, and the User model.

Running Tests

To run all tests, run

python manage.py test

Migrations

Whenever a database migration needs to be made. Run the following commands:

python manage.py db migrate

This will generate a new migration script. Then run:

python manage.py db upgrade

To apply the migration.

For a full migration command reference, run python manage.py db --help.

About

Material Design Lite Template in a Flask Project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 43.4%
  • HTML 38.3%
  • CSS 18.1%
  • JavaScript 0.2%