Add project documentation, license and gitignore

2026-08-25 10:17:53 +02:00
commit 8e0a33b4fd
4 changed files with 223 additions and 0 deletions
@@ -0,0 +1,36 @@
+# Blog
+
+Blog platform: a public website built with Nuxt, and a private Strapi CMS where
+editors write the articles. Everything runs behind Caddy via Docker Compose.
+
+```text
+Browser → Caddy ─┬─ public domain → Nuxt (website)
+                 └─ cms subdomain → Strapi (CMS) → PostgreSQL
+```
+
+> Status: bootstrap. The application code is not in place yet.
+
+## Getting started
+
+Requires Docker and Node.js 20+.
+
+```bash
+cp .env.example .env    # fill in the secrets, never commit this file
+docker compose up -d --build
+```
+
+Then open the CMS URL to create the first admin account and start publishing.
+The public site picks up published articles automatically.
+
+## Working on it
+
+```bash
+cd frontend && npm run dev    # website
+cd cms && npm run develop     # CMS
+```
+
+Architecture, conventions and constraints are documented in [CLAUDE.md](CLAUDE.md).
+
+## License
+
+Proprietary — Copyright (c) 2026 Davide Grilli. All rights reserved. See [LICENSE](LICENSE).