Quick App Setup

The Quick App Setup provides the simplest way to start and test The Wall API. It is designed to minimize the prerequisites and required file structure, making it an ideal choice for quickly running the application with minimal configuration. While optimized for demonstration purposes, it retains the application’s full functionality.

Step-by-step instructions

1. Download docker-compose-demo.yml, located in the config/docker/ folder of the repository.

curl -o docker-compose-demo.yml https://raw.githubusercontent.com/Alexandar83/the-wall-api/refs/heads/main/config/docker/docker-compose-demo.yml

2. Pull the app and directly start it with all of its services:

docker compose -p the-wall-api-demo -f docker-compose-demo.yml up -d

💡 The command must be executed from the folder, where the docker-compose-demo.yml file is located.

💡 Windows: Docker Desktop must be running.

💡 Linux: Docker must be running.

3. Send requests to the API endpoints:

• http://localhost:8000/api/v2/
• http://localhost:8000/api/v2/swagger-ui/

4. To stop the app:

docker compose -p the-wall-api-demo -f docker-compose-demo.yml down

📌 Action required: To use the other setups, remove all images and volumes, related to the app and the Celery services:

docker volume rm the_wall_api_redis_data_demo
docker volume rm the_wall_api_postgres_data_demo
docker volume rm the_wall_api_celery_beat_schedule_demo
docker volume rm the_wall_api_shared_sim_logs_demo
docker rmi ghcr.io/alexandar83/the-wall-api-demo
docker rmi ghcr.io/alexandar83/celery-lightweight-demo

🗒️ Note: The images for the Redis and PostgreSQL services may be reused in all setups.

💡 Verify that the volumes and images are removed:

docker volume ls
docker images

💡 If either of the images becomes untagged, it has to be removed by its image id:

docker rmi <image_id>

⚠️ Disclaimer: The demo image and docker-compose-demo.yml are designed for quick setup and portability, intentionally omitting security and sensitive data considerations to streamline demonstration purposes.

---

Return to Top
Installation Instructions Index
Home Page

---