Flask-Beginner

A curated list of awesome projects related to Flask.

Flask is a lightweight WSGI web application framework written in Python.

Initial Setup

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

.. code-block:: bash

export CONDUIT_SECRET='something-really-secret'

Before running shell commands, set the FLASK_APP and FLASK_DEBUG environment variables ::

export FLASK_APP=/path/to/autoapp.py
export FLASK_DEBUG=1

Then run the following commands to bootstrap your environment ::

git clone repo-name
cd folder
pip3 install -r requirements.txt

Run the following commands to create your app's database tables and perform the initial migration ::

flask db init
flask db migrate
flask db upgrade

To run the web application use::

flask run --with-threads

Deployment

In your production environment, make sure the FLASK_DEBUG environment variable is unset or is set to 0, so that ProdConfig is used, and set DATABASE_URL which is your postgresql URI for example postgresql://localhost/example (this is set by default in heroku).

Shell

To open the interactive shell, run ::

flask shell

By default, you will have access to the flask app and models.

Running Tests

To run all tests, run ::

flask test

Migrations

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

flask db migrate

This will generate a new migration script. Then run ::

flask db upgrade

To apply the migration.

For a full migration command reference, run flask db --help.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

None

Star the Repo in case you liked it :)

© kehsihba19