Add README.md with project overview and architecture

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Lucas 2025-06-14 15:16:17 +02:00
parent 7a4fa4b312
commit d7e7e81ab9

22
README.md Normal file
View file

@ -0,0 +1,22 @@
# Web Development Playground
This project has two main goals:
1. **Learn web development basics** - Practice HTML, CSS, and vanilla JavaScript with a simple backend that has low dependencies and is easy to run
2. **Build minimal examples** - Create the basic features needed for a hobby browser game project
## Architecture
This repository contains the HTML/CSS/JavaScript frontend and Go backend code. The full setup relies on external components not included in this repo:
- **Caddy webserver** - Serves the HTML/CSS/JS files directly and handles authentication
- **Authelia** - Provides user authentication and session management
- **Reverse proxy** - API requests are forwarded from Caddy to the running Go executable
## Learning Focus
This is a learning project that prioritizes **readability and simplicity** over "best practices" or complex patterns. No massive dependencies or frameworks will be introduced - keeping everything straightforward and easy to understand.
The project includes cheat sheets explaining common patterns used:
- Go patterns commonly found in this codebase (for those less familiar with Go)
- JavaScript patterns may be added if needed