This project delivers a robust headless API using Django and Django REST Framework, with support for both synchronous and asynchronous environments facilitated by Uvicorn (ASGI) and Gunicorn (WSGI) respectively. It leverages Django Allauth for authentication, utilizes Celery with Redis for task management, and employs Postgres for data storage. Features include caching, multi-language support, and comprehensive test coverage. The API also includes a built-in Django admin panel for efficient administrative operations.
The Django applications within this project include:
- Core: Core functionalities and shared utilities.
- User: User management and authentication.
- Product: Product catalog management.
- Order: Order processing and management.
- Search: Advanced search capabilities.
- Slider: Dynamic UI sliders for promotions and highlights.
- Blog: Content management for blog posts.
- SEO: SEO tools and configurations.
- Tip: User tips and advice sections.
- VAT: VAT calculation and management.
- Country: Country-specific configurations.
- Region: Regional data and settings.
- Pay Way: Payment method configurations.
- Session: User session management.
- Cart: Shopping cart functionalities.
- Notification: User notification mechanisms.
- Authentication: Additional authentication layers.
- Contact: Contact management and communication tools.
- Authentication and User Management: Streamlined user account and session management.
- Multi-Language Support: Accommodates various languages enhancing global usability.
- Advanced Search and Filtering: Leverages Postgres Full-Text Search for efficient data retrieval.
- Task Scheduling: Utilizes Celery for background task management.
- Performance Optimization: Implements caching strategies to improve API responsiveness.
- Testing: Includes comprehensive unit and integration tests.
- Admin Panel: Django's built-in admin panel for straightforward management.
- API Documentation: Well-documented API using Swagger and Redoc.
- Containerization: Docker integration for simplified setup and deployment.
- Frameworks: Django, Django REST Framework
- Authentication: Django Allauth
- Database: PostgreSQL
- Task Management: Celery
- Message Broker: Redis
- Server Setup: Uvicorn (ASGI), Gunicorn (WSGI)
- Containerization: Docker
- Package & Project Management: UV
- Python 3.13 or higher
- Django 5.0 or higher
- PostgreSQL
- Redis
This project is open-sourced under the MIT License. See the LICENSE file for more details.
-
Run DB Migrations:
docker compose run backend sh -c "python manage.py makemigrations --noinput" -
Apply Migrations:
docker compose run backend sh -c "python manage.py migrate"
-
Create Superuser:
docker compose run backend sh -c "python manage.py createsuperuser"
-
Collect Static Files:
docker compose run backend sh -c "python manage.py collectstatic --noinput"
-
Run Tests:
docker compose run backend sh -c "python manage.py test tests/" -
Run Tests with Coverage (excluding specific files and folders):
docker compose run backend sh -c "coverage run --omit=*/migrations/*,*/management/*,*/manage.py,*/setup.py,*/asgi.py,*/wsgi.py --source='.' manage.py test tests/ && coverage report && coverage html" -
Generate Coverage HTML Reports:
docker compose run backend sh -c "coverage html"
-
Seed Database with Fake Data:
docker compose run backend sh -c "python manage.py seed_all"
-
Run with Specific Compose File:
docker compose -f <docker-compose-file.yml> up -d --build
-
Execute Command in Container:
docker exec -it <container_id> <command> -
Run Specific Shell Command:
docker exec -it <container_id> sh -c "<command>"
-
Generate Locale Messages:
docker exec -it <container_id> sh -c "uv run django-admin makemessages -a -
Compile Locale Messages:
docker exec -it <container_id> sh -c "uv run django-admin compilemessages"
-
Run a local Celery beat scheduler using the Django database scheduler:
celery -A core beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler -
Run a Celery worker:
celery -A core worker -E -l info --pool=solo -
Monitor Celery with Flower:
celery -A core flower --broker=amqp://guest:guest@localhost:5672// --broker_api=http://guest:guest@localhost:15672/api// --port=5555
-
Start Uvicorn for ASGI applications:
python manage.py runserver 0.0.0.0:8000
-
Install Django:
pip install django -
Start a New Project:
django-admin startproject <project_name> -
Start a New App:
python manage.py startapp <app_name> -
Database Migrations and Management:
- Make migrations:
python manage.py makemigrations - Apply migrations:
python manage.py migrate - Flush the database:
python manage.py sqlflush - Populate database with seed data (All Factories Example):
python manage.py seed_all --model-counts="Country=10,Product=100"
- Make migrations:
-
Manage Users:
- Create superuser:
python manage.py createsuperuser
- Create superuser:
-
Manage Static Files:
python manage.py collectstatic -
Testing and Debugging:
- Run tests:
python manage.py test - Access Django shell:
python manage.py shell - Enhanced shell:
python manage.py shell_plus - Database shell:
python manage.py dbshell
- Run tests:
-
Run Development Server:
python manage.py runserver
-
Navigate to Source Directory:
cd src -
Pre-commit and Ruff Formatting:
- Install pre-commit hooks:
uv run pre-commit install - Run pre-commit hooks:
uv run pre-commit run --all-files - Check and Fix code with Ruff:
uv run ruff check --fix - Format code with Ruff:
uv run ruff format
- Install pre-commit hooks:
-
Generate API Schema:
uv run python manage.py spectacular --color --file schema.yml
-
Delete Remote Tags:
- Delete all remote tags:
git tag -l | xargs -n 1 git push --delete origin
- Delete all remote tags:
-
Delete Local Tags:
- Delete all local tags:
git tag -l | xargs git tag -d
- Delete all local tags:
