Django-base-code

This repo contains ready-to use base code for django applications.

Features

• Custom User Module with Auth
• Unit Test Cases
• PostgreSQL
• Docker
• Ready to deploy configs
• Github Actions
• Swagger (API Docs)
• Ready to use as a base code
• Usage Examples
  • Example:01 - Recipe, Ingredients, Recipe-Tags APIs
  • Example:02 - [Work in Process] E-commerce APIs

Prerequisites

• Python 3.9
• Docker
• VScode

How to use?

To build docker image

  docker-compose build

To run app

  docker-compose up

To stop app

  docker-compose down

To execute tests

  docker-compose run --rm app sh -c "python manage.py test"

Authors

• Faique Ali

Contributing

Contributions are always welcome!

• Create your Work Branch git checkout -b dev/<task_name>
• Commit your Changes git commit -m '<What changes you've done>'
• Push to the Branch git push origin dev/<task_name>
• Open a Pull Request

Please adhere to this project's code of conduct.

🔗 Connect Me