README.md

_{^{Description • Stack • Installation • Database • Running the app • Endpoints • Test • Video Tutorials • Helpful repos • License}}

Description

A dockerized Django API for locking resources preventing multiple users from making changes. Authentication, input validation, API versioning and testing included.

Stack

Language	Python
Framework	Django
Database	SQLite3
Cache	Redis
Linter	Black
CI	AppVeyor

Installation

# Create virtual environment
$ python -m venv .venv

# Activate virtual environment
$ source .venv/bin/activate

# Install dependecies
$ pip install -r requirements.txt

Database

# Generate migrations
$ python manage.py makemigrations

# Apply migrations
$ python manage.py migrate

# Create admin user
$ python manage.py createsuperuser

# Launch redis
$ docker-compose up redis -d

# Redis cli
$ docker-compose exec redis redis-cli -a pass -n 1

Running the app

# Launch server
$ python manage.py runserver

Endpoints

# API
http://localhost:8000/api

# Swagger UI
http://localhost:8000/docs

# Administration UI
http://localhost:8000/admin

Test

# Run tests
$ python manage.py test

# Run tests with code coverage
$ python run_tests_with_coverage.py

Video Tutorials

• freeCodeCamp.org - Django REST Framework Coursen
• Dave Gray - Python Django Full Course
• Tech with Tim - Learn Django
• PedroTech - Python Django REST API

Helpful repos

• https://github.com/bobby-didcoding/drf_course/tree/main
• https://github.com/gitdagray/django-course/tree/main
• https://github.com/techwithtim/django-rest-api/tree/main
• https://github.com/machadop1407/react-django-tutorial/tree/main
• https://github.com/ArchTaqi/django-rest-api/tree/master

License

This project is licensed under the MIT License - see the LICENSE file for details.