Web service voor het LED-display
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

89 lines
1.8 KiB

===============================
11 years ago
{{ cookiecutter.project_name }}
===============================
11 years ago
{{ cookiecutter.project_short_description}}
Quickstart
----------
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 {{cookiecutter.app_name | upper}}_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 https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.app_name}}
cd {{cookiecutter.app_name}}
11 years ago
pip install -r requirements/dev.txt
npm install
npm start # run the webpack dev server
flask run # run the flask 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 ::
flask db init
flask db migrate
flask db upgrade
flask run
Deployment
----------
To deploy::
export FLASK_DEBUG=0
npm run build
flask run
In your production environment, make sure the ``FLASK_DEBUG`` environment
variable is unset or is set to ``0``, so that ``ProdConfig`` is used.
Shell
-----
To open the interactive shell, run ::
flask shell
By default, you will have access to the flask ``app``.
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``.