Django cookiecutter

Django-Cookiecutter is a quick-start project template for building Django web applications with the Django Rest Framework Postgres Redis Celery CircleCI GitLab CI and Docker. This project template provides a solid foundation for building scalable and maintainable web applications with Django and its ecosystem.

🛠️ Installation Steps:

1. clone the repo

git clone [email protected]:Godfrey-Ndungu/django-cookiecutter.git

2. cd django-cookiecutter

3. make makefile.sh executable

chmod +x makefile.sh

4. Run makefile

./makefile.sh

💻 Built with

Technologies used in the project:

• Django
• Django-rest-framework
• swager-ui
• redis
• postgresql
• docker
• celery

Local Environment Variables

The following environment variables are required to run this project locally. Please set them with appropriate values:

SECRET_KEY

ALLOWED_HOSTS

DEBUG

DB_NAME

DB_USER

DB_PASSWORD

DB_HOST

DB_PORT

Production Environment Variables

SECRET_KEY

ALLOWED_HOSTS

DEBUG

DB_NAME

DB_USER

DB_PASSWORD

DB_HOST

DB_PORT

AWS_ACCESS_KEY_ID

AWS_SECRET_ACCESS_KEY

AWS_STORAGE_BUCKET_NAME

AWS_QUERYSTRING_AUTH

AWS_DEFAULT_ACL

AWS_S3_SIGNATURE_VERSION

AWS_S3_OBJECT_PARAMETERS

PUBLIC_MEDIA_LOCATION

MEDIAFILES_LOCATION

AWS_CLOUDFRONT_DOMAIN

Run Locally

Clone the project

  chmod +x makefile.sh
  ./makefile.sh

Run Tests

Clone the project

  tox