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.
Jeremy Epstein
5010ebc949
|
8 years ago | |
---|---|---|
.. | ||
requirements | 8 years ago | |
tests | 9 years ago | |
{{cookiecutter.app_name}} | 8 years ago | |
.bowerrc | 11 years ago | |
.gitignore | 9 years ago | |
.isort.cfg | 9 years ago | |
.travis.yml | 9 years ago | |
LICENSE | 10 years ago | |
Procfile | 11 years ago | |
README.rst | 8 years ago | |
bower.json | 10 years ago | |
requirements.txt | 11 years ago | |
setup.cfg | 9 years ago |
README.rst
===============================
{{ cookiecutter.project_name }}
===============================
{{ cookiecutter.project_short_description}}
Quickstart
----------
First, set your app's secret key as an environment variable. For example, example add the following to ``.bashrc`` or ``.bash_profile``.
.. code-block:: bash
export {{cookiecutter.app_name | upper}}_SECRET='something-really-secret'
Then run the following commands to bootstrap your environment.
::
git clone https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.app_name}}
cd {{cookiecutter.app_name}}
pip install -r requirements/dev.txt
bower install
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
----------
Before running shell commands, set the ``FLASK_APP`` environment variable ::
export FLASK_APP="{{cookiecutter.app_name}}.autoapp"
In your production environment, make sure the ``{{cookiecutter.app_name|upper}}_ENV`` environment variable is set to ``"prod"``.
Shell
-----
To open the interactive shell, run ::
flask shell
By default, you will have access to ``app``, ``db``, ``g``, and the ``User`` model.
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``.