https://github.com/johnpooch/django_template

https://github.com/johnpooch/django_template

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/johnpooch/django_template
• Owner: johnpooch
• Created: 2021-12-27T17:16:49.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-03T19:40:00.000Z (about 3 years ago)
• Last Synced: 2024-11-11T17:48:24.071Z (2 months ago)
• Language: Python
• Size: 18.6 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Django project template

## Getting started

These instructions will get you started with a copy of the project up on your

local machine for development and testing purposes.

### Docker set up

#### Prerequisites

This set up uses [Docker][docker] and [Docker Compose][docker-compose] for local

development. Follow the docs to get Docker and Docker Compose installed.

#### Bring up local copy

- Run `docker-compose up` to bring up the project (You can run detached by

  adding `-d` flag)

- Once the containers are up you can run commands from inside the docker

  service container by running `docker exec -it django_template_project.web_1`

  and then running whatever command you like.

## Running the tests

From within the service container run `python3 manage.py test`.

### Linting

Run flake8 to check for code style problems. Run `flake8 .` from the project

root. If there are code style problems they will be displayed.

## Test Coverage

To generate a test coverage report test coverage, run `coverage run manage.py test` from within the container. Then run `coverage report` to see the results.

[docker]: https://docs.docker.com/

[docker-compose]: https://docs.docker.com/compose/