Skip to content

Commit

Permalink
Add documentation on 'getting up and running'
Browse files Browse the repository at this point in the history
Some hopefully usefully instructions to help people get up and running.

Re: Issue cookiecutter#34 On my machine I didn't need to install memcached to successfully install the local requirements.

Re: Issue cookiecutter#39 I've linked to this issue for now. It would be good to remove the need for those steps and then this link can be removed.
  • Loading branch information
Tom Atkins authored and theskumar committed Feb 13, 2014
1 parent 4b8c730 commit d615446
Showing 1 changed file with 41 additions and 1 deletion.
42 changes: 41 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,48 @@ Create a GitHub repo and push it there::

Now take a look at your repo. Don't forget to carefully look at the generated README. Awesome, right?

It's time to write the code!!!
Getting up and running
----------------------

The steps below will get you up and running with a local development environment. We assume you have the following installed:

* pip
* virtualenv
* PostgreSQL

First make sure to create and activate a virtualenv, then open a terminal at the project root and install the requirements for local development::

$ pip install -r requirements/local.txt

You can now run the usual Django ``runserver`` command (replace ``yourapp`` with the name of the directory containing the Django project)::

$ python yourapp/manage.py runserver

The base app will run but you'll need to carry out a few steps to make the sign-up and login forms work. These are currently detailed in `issue #39`_.

.. _issue #39: https://github.com/pydanny/cookiecutter-django/issues/39

**Live reloading and Sass CSS compilation**

If you'd like to take advantage of live reloading and Sass / Compass CSS compilation you can do so with the included Grunt task.

Make sure that nodejs_ is installed. Then in the project root run::

$ npm install

.. _nodejs: http://nodejs.org/download/

Now you just need::

$ grunt serve

The base app will now run as it would with the usual ``manage.py runserver`` but with live reloading and Sass compilation enabled.

To get live reloading to work you'll probably need to install an `appropriate browser extension`_

.. _appropriate browser extension: http://feedback.livereload.com/knowledgebase/articles/86242-how-do-i-install-and-use-the-browser-extensions-

It's time to write the code!!!

"Your Stuff"
-------------
Expand Down

0 comments on commit d615446

Please sign in to comment.