How m8ke/aircloud works
Project type and purpose
• This is a full-stack, self-hostable, web-based P2P file-sharing application (“AirCloud”) built on WebRTC.
• The client is an Angular SPA; the server is a Spring Boot WebSocket signaling service; auxiliary services include TURN/STUN (Coturn) and Nginx as a proxy/reverse-proxy.
File-structure highlights
• Top-level:
• client/ → Angular application (TypeScript, components, services, utils, assets, Dockerfile)
• server/ → Spring Boot (Java, WebSocket signaling, DTOs, application.yml, Dockerfile)
• nginx/ → templates and configs for reverse-proxy and cert management
• docker-compose.yml & docker-compose.dev.yml → orchestrate client, server, coturn, nginx
• .github/workflows → CI/CD for client, server, deploy
Key insights from README
• Core architecture:
• Frontend: Angular + WebRTC (data-channel + Zip.js)
• Backend: Spring Boot + WebSocket signaling
• TURN/STUN via Coturn for NAT traversal
• Nginx for TLS termination / reverse proxy / static asset hosting
• No persistent storage; ephemeral sessions, end-to-end encrypted P2P transfer.
• Angular Client (Browser)
• Nginx Reverse Proxy
• Spring Boot Signaling Server (WebSocket)
• Coturn (TURN/STUN) Service
• Peer Browser (second client endpoint)
• (Optional) Certbot / Let's Encrypt ACME
1. User’s Browser ↔︎ Nginx (HTTPS)
2. Nginx ↔︎ Angular assets (static files)
3. Browser’s Angular code → WebSocket handshake → Nginx → Signaling Server
4. Signaling Server ↔︎ other peers via WebSocket (exchange SDP, ICE candidates)
5. Browsers ↔︎ TURN/STUN (via ICE) to establish direct P2P DataChannel
6. Browser ↔︎ Browser (WebRTC DataChannel) for encrypted file transfers
c. Architectural patterns & design principles:
• Layered separation: Reverse proxy → API (signaling) → P2P network
• Event-driven WebSocket signaling
• Microservices-style deployment via Docker Compose
• No central storage: ephemeral, in-memory sessions only
d. Technologies & frameworks:
• Angular (client SPA) / TypeScript
• WebRTC API & Zip.js (client-side bundling + encryption)
• Spring Boot WebSocket (server)
• Coturn (TURN/STUN)
• Nginx + Docker + Docker Compose
• GitHub Actions (CI/CD)
Detail-capture checklist
• Docker Compose grouping: client, server, coturn, nginx.
• Ports: 80/443 (Nginx), 8080 or WSS port (signaling), 3478 UDP/TCP (Coturn).
• Optional Certbot container or ACME flow if self-hosting HTTPS.