Skip to content

Commit

Permalink
Merge pull request #257 from audreyr/document-user-setup
Browse files Browse the repository at this point in the history
Document user setup
  • Loading branch information
pydanny committed Jun 28, 2015
2 parents 6c163c1 + f370702 commit 504e170
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions {{cookiecutter.repo_name}}/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ EMAIL_SUBJECT_PREFIX EMAIL_SUBJECT_PREFIX n/a
Getting up and running
----------------------

Basics
^^^^^^

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

* pip
Expand All @@ -68,11 +71,21 @@ You can now run the ``runserver_plus`` command::

$ python manage.py runserver_plus

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`_.
Open up your browser to http://127.0.0.1:8000/ to see the site running locally.

Setting Up Your Users
^^^^^^^^^^^^^^^^^^^^^

To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

To create an **superuser account**, use this command::

$ python manage.py createsuperuser

.. _issue #39: https://github.com/pydanny/cookiecutter-django/issues/39
For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

**Live reloading and Sass CSS compilation**
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.

Expand Down

0 comments on commit 504e170

Please sign in to comment.