Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document user setup #257

Merged
merged 2 commits into from
Jun 28, 2015
Merged

Document user setup #257

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9e560e
Break up 'Getting up and running' into more readable sections
audreyfeldroy Jun 28, 2015
f370702
Instructions for creating user accounts. Fix #39.
audreyfeldroy Jun 28, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions {{cookiecutter.repo_name}}/README.rst
View file
Open in desktop
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