cookiecutter/cookiecutter-django
1
1
Fork 0
mirror of https://github.com/cookiecutter/cookiecutter-django.git synced 2025-02-18 04:20:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1 from Lyla-Fischer/master

Browse Source 
Docs clarifications
This commit is contained in:
Nate Aune 2013-10-07 14:35:35 -07:00
commit e78f53b5d5
2 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.rst
View File

@ -83,8 +83,11 @@ Create a GitHub repo and push it there::
Now take a look at your repo. Awesome, right?
It's time to write the code!!!
If you check out your new application, you will see that you can find documentation in the "docs" directory that explains everything about your app as it exists in its initial cookiecutter state, including how to deploy it.
If you want to read the documentation from your browser instead of a text editing window, you'll have to compile it first. First, make sure that you have all of the local packages that you need (including the ones you need to generate this documentation) by running "pip install -r requirements/local.txt". Go into the docs directory and run "make html". That will generate html from the .rst files. Point your browser to your local variant of "/path/to/my_cookiecutter_project/docs/_build/html/index.html".
So, you now have a simple django application. Go forth and code!
"Your Stuff"
-------------

21
{{cookiecutter.repo_name}}/docs/deploy.rst
View File

@ -46,6 +46,21 @@ Add memcachier for memcached service::
MemCachier is now up and ready to go. Happy bananas!
Use `heroku addons:docs memcachier` to view documentation.
Look up the name of your database. You should have gotten the name as part of the feedback when you created the
database, but just in case you lost that record::
$ heroku pg
=== HEROKU_POSTGRESQL_GOLD_URL (DATABASE_URL)
Plan: Dev
Status: available
Connections: 1
PG Version: 9.2.4
Created: 2013-09-29 02:00 UTC
Data Size: 6.3 MB
Tables: 0
Rows: 0/10000 (In compliance)
Fork/Follow: Unsupported
Promote the database you just created. Please note that your database might be called something other than "GOLD"::
$ heroku pg:promote HEROKU_POSTGRESQL_GOLD
@ -109,7 +124,11 @@ TODO: Explain how to serve static files with dj-static_.
.. _dj-static: https://github.com/kennethreitz/dj-static
Run this script: (TODO - automate this)
Open up a django shell on your heroku instance::
$ heroku run python {{cookiecutter.repo_name}}/manage.py shell --settings=config.settings
Run the following lines of code from within that shell: (TODO - automate this)
.. code-block:: python