README.md

django-rest-base-project

Main =>
Dev ==>
InDev =>
Template project for all Django Rest services developed

Tools and Resources

1. Python 3.8 link
2. Virtualenv
3. Postgresql
   1. Download the application link.
   2. Install Postgresql and set up root (postgres). linux link windows link
   3. Create base database.

Setup

*Note**: Make sure to download/clone this repository and navigate to the folder in your terminal. Now follow the instructions below

1. Create the virtual environment.

virtualenv /path/to/venv --python=/path/to/python3

You can find out the path to your python3 interpreter with the command which python3.

1. Set up .env file by duplicating the .example.env file(and editing if required).

2. Activate the environment and install dependencies.

   • Linux

   source /path/to/venv/bin/activate
   pip install -r requirements.txt

   • Windows

   ./path/to/venv/bin/activate
   pip install -r requirements.txt

3. Launch the app

   python manage.py runserver localhost:8000

Test Project

• Run all tests

  pytest

Development

1. launch app with docker compose

   docker-compose up --build --remove-orphans

REFERENCES

• Django
• DRF
• Django Debug Toolbar
• Django Storages, for AWS S3
• Pytest for Django including coverage
• Python Decouple: Strict separation of settings from code
• Gunicorn
• The Twelve Factor App