From e9e560eb17f5a120464e59132649695d796fb74a Mon Sep 17 00:00:00 2001 From: Audrey Roy Date: Sun, 28 Jun 2015 14:42:51 -0700 Subject: [PATCH 1/2] Break up 'Getting up and running' into more readable sections --- {{cookiecutter.repo_name}}/README.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index 02b9f241..8e7b318d 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -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 @@ -68,11 +71,17 @@ 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`_. +Setting Up Your Users +^^^^^^^^^^^^^^^^^^^^^ + +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** +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. From f370702c4d03516e80e290194f52ca6322d58fb0 Mon Sep 17 00:00:00 2001 From: Audrey Roy Date: Sun, 28 Jun 2015 14:55:25 -0700 Subject: [PATCH 2/2] Instructions for creating user accounts. Fix #39. --- {{cookiecutter.repo_name}}/README.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.repo_name}}/README.rst b/{{cookiecutter.repo_name}}/README.rst index 8e7b318d..f746aa96 100644 --- a/{{cookiecutter.repo_name}}/README.rst +++ b/{{cookiecutter.repo_name}}/README.rst @@ -71,14 +71,18 @@ You can now run the ``runserver_plus`` command:: $ python manage.py runserver_plus +Open up your browser to http://127.0.0.1:8000/ to see the site running locally. + Setting Up Your Users ^^^^^^^^^^^^^^^^^^^^^ -The base app will run but you'll need to carry out a few steps to make the sign-up and login forms work. +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. -These are currently detailed in `issue #39`_. +To create an **superuser account**, use this command:: -.. _issue #39: https://github.com/pydanny/cookiecutter-django/issues/39 + $ python manage.py createsuperuser + +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 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^