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.
63 lines
1.1 KiB
63 lines
1.1 KiB
11 years ago
|
===============================
|
||
11 years ago
|
{{ cookiecutter.project_name }}
|
||
11 years ago
|
===============================
|
||
11 years ago
|
|
||
|
{{ cookiecutter.project_short_description}}
|
||
|
|
||
|
|
||
|
Quickstart
|
||
|
----------
|
||
|
|
||
|
::
|
||
11 years ago
|
|
||
11 years ago
|
git clone https://github.com/{{cookiecutter.github_username}}/{{ cookiecutter.app_name }}
|
||
|
cd {{cookiecutter.app_name}}
|
||
11 years ago
|
pip install -r requirements/dev.txt
|
||
11 years ago
|
python manage.py db init
|
||
|
python manage.py db migrate
|
||
|
python manage.py db upgrade
|
||
11 years ago
|
python manage.py server
|
||
11 years ago
|
|
||
|
|
||
11 years ago
|
|
||
11 years ago
|
Deployment
|
||
|
----------
|
||
|
|
||
11 years ago
|
In your production environment, make sure the ``{{cookiecutter.app_name|upper}}_ENV`` environment variable is set to ``"prod"``.
|
||
11 years ago
|
|
||
|
|
||
11 years ago
|
Shell
|
||
|
-----
|
||
|
|
||
|
To open the interactive shell, run ::
|
||
|
|
||
|
python manage.py shell
|
||
|
|
||
11 years ago
|
By default, you will have access to ``app`` and ``db``.
|
||
11 years ago
|
|
||
|
|
||
|
Running Tests
|
||
|
-------------
|
||
|
|
||
|
To run all tests, run ::
|
||
|
|
||
|
python manage.py test
|
||
11 years ago
|
|
||
|
|
||
|
Migrations
|
||
|
----------
|
||
|
|
||
|
Whenever a database migration needs to be made. Run the following commmands:
|
||
|
::
|
||
|
|
||
|
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``.
|