Home

Welcome to the Project Wiki

This documentation offers a comprehensive guide to The Wall API, a containerized Django REST framework project simulating the construction of a massive ice wall inspired by fictional themes. It is tailored for developers and architects with expertise in containerized workflows and API-based system designs, serving as a detailed resource for project setup, API usage, and technical exploration.

📚 Table of Contents

1. Project Overview

2. Features

3. Dependencies

4. Quick Start

5. Installation Instructions Index

Toggle Index

• Cross-platform
  • Quick App Setup
  • Production Setup v1
• Windows
  • Proxy Wall Creation
  • Local Development Setup
  • Production Setup v2
• Linux (WSL2)
  • Proxy Wall Creation
  • Local Development Setup
  • Production Setup v2
• Application Scripts Index

6. API Access Overview

7. Detailed Functional Specification

Toggle Index

• User Management
• General Workflow and Swagger-UI Guide
• Wall Construction Overview
• Detailed Cost and Resource Calculations
• Operational Limitations

8. Detailed Technical Specification

Toggle Index

• System Overview
• Project Folder Structure
• Django Rest Framework
  • DRF Configuration
  • API URL Routing
  • Authentication (Djoser)
  • File Management Endpoints
  • Profiles Endpoints
  • Error Handling
  • Message Themes
  • API Throttling
• Environment Variables Index
• PostgreSQL - Database Configuration
• Redis - In-Memory Cache & Celery Message Broker
• Celery - Asynchronous Task Processing
• Sequential and Concurrent Simulation Modes
• Test Suite
• Containerization
  • Docker - Local Development
  • Docker - Production v1 and Demo
  • Docker - Production v2
• DRF Spectacular

About This Project

The Wall API is a Django REST Framework application designed to demonstrate threading and multiprocessing within containerized environments. It showcases the following technical highlights:

1. Threading and Multiprocessing: Implements both sequential and concurrent simulations, handling tasks across multiple threads or processes.
2. Django Framework: Built with Django, leveraging its robust ecosystem for developing RESTful APIs and database-backed applications.
3. Docker Containerization: Utilizes Docker to ensure modularity, portability, and seamless deployments across different environments.
4. Distributed Task Processing: Leveraging Celery for asynchronous task execution and scheduling.
5. Database and Caching: Robust data storage with PostgreSQL and performance optimization with Redis.
6. OpenAPI Documentation: Detailed API documentation is generated using Swagger-UI and ReDoc.

From Ancient Frost to Cutting-Edge Design

"The White Walkers sleep beneath the ice for thousands of years. And when they wake up..."
"And when they wake up... what?"
"I hope the Wall is high enough."

Inspired by the fictional Game of Thrones universe, this project weaves thematic storytelling with technical prowess, simulating a massive construction process with realistic cost and resource tracking.

---