Getting Up and Running Locally

Setting Up Development Environment

Make sure to have the following on your host:

First things first.

  1. Create a virtualenv.

  2. Activate the virtualenv you have just created.

  3. Install development requirements:

    $ pip install -r requirements/local.txt
    
  4. Create a new PostgreSQL database (note: if this is the first time a database is created on your machine you might need to alter a localhost-related entry in your pg_hba.conf so as to utilize trust policy):

    $ createdb <what you've entered as the project_slug at setup stage>
    
  5. Apply migrations:

    $ python manage.py migrate
    
  6. See the application being served through Django development server:

    $ python manage.py runserver 0.0.0.0:8000
    

Setup Email Backend

MailHog

Note

In order for the project to support MailHog it must have been bootstrapped with use_mailhog set to y.

MailHog is used to receive emails during development, it is written in Go and has no external dependencies.

For instance, one of the packages we depend upon, django-allauth sends verification emails to new users signing up as well as to the existing ones who have not yet verified themselves.

  1. Download the latest MailHog release for your OS.

  2. Rename the build to MailHog.

  3. Copy the file to the project root.

  4. Make it executable:

    $ chmod +x MailHog
    
  5. Spin up another terminal window and start it there:

    ./MailHog
    
  6. Check out http://127.0.0.1:8025/ to see how it goes.

Now you have your own mail server running locally, ready to receive whatever you send it.

Console

Note

If you have generated your project with use_mailhog set to n this will be a default setup.

Alternatively, deliver emails over console via EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'.

In production, we have Mailgun configured to have your back!

Sass Compilation & Live Reloading

If you’d like to take advantage of live reloading and Sass compilation you can do so with a little bit of preparation.

Summary

Congratulations, you have made it! Keep on reading to unleash full potential of Cookiecutter Django.