https://github.com/martibosch/cookiecutter_django_doge_example

Example Django app using the cookiecutter-django-doge template
https://github.com/martibosch/cookiecutter_django_doge_example

Last synced: 4 days ago
JSON representation

Example Django app using the cookiecutter-django-doge template

• Host: GitHub
• URL: https://github.com/martibosch/cookiecutter_django_doge_example
• Owner: martibosch
• License: other
• Created: 2022-11-22T09:54:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-16T14:11:00.000Z (almost 2 years ago)
• Last Synced: 2024-06-11T16:30:30.945Z (7 months ago)
• Language: Python
• Size: 90.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# Cookiecutter Django Doge example

Example Django app using the cookiecutter-django-doge template

[![Built with Cookiecutter Django](https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter)](https://github.com/cookiecutter/cookiecutter-django/)

[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)

License: GPLv3

## Settings

Moved to [settings](http://cookiecutter-django.readthedocs.io/en/latest/settings.html).

## Basic Commands

### 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 a **superuser account**, use this command:

        $ 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.

### Type checks

Running type checks with mypy:

    $ mypy cookiecutter_django_doge_example

### Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

    $ coverage run -m pytest

    $ coverage html

    $ open htmlcov/index.html

#### Running tests with pytest

    $ pytest

### Live reloading and Sass CSS compilation

Moved to [Live reloading and SASS compilation](https://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html#sass-compilation-live-reloading).

## Deployment

The following details how to deploy this application.

### Docker

See detailed [cookiecutter-django Docker documentation](http://cookiecutter-django.readthedocs.io/en/latest/deployment-with-docker.html).