docs(readme): add readme file about the project

Root readme file contains task completion status, as well as intruction
on how to run project in development stage using docker compose
This commit is contained in:
Leons Aleksandrovs
2025-07-07 22:08:18 +03:00
parent 3664079c40
commit 3c394bddfb
4 changed files with 139 additions and 3 deletions

14
caddy/README.md Normal file
View File

@@ -0,0 +1,14 @@
# Caddy
This directory contains the configuration for the Caddy web server.
## Purpose
Caddy is used as a reverse proxy to route traffic to the appropriate services:
- Requests to `/` are served by the frontend Vue.js application.
- Requests to `/ws` are proxied to the backend WebSocket server.
## Project Structure
- **Caddyfile**: The main configuration file for Caddy. It defines how Caddy should serve the application, including reverse proxying to the frontend and backend services.