docs: add project documentation and initial specs

2026-03-14 13:29:32 +01:00
parent 35734bd2d9
commit 143b441d0c
11 changed files with 819 additions and 0 deletions
@@ -0,0 +1,138 @@
+# Project Overview
+
+## Summary
+
+This project is a multilingual
+
+`Next.js`
+
+portfolio website with an authenticated
+
+`admin`
+
+workspace.
+
+The current implementation centers on:
+
+- Public marketing pages
+- Portfolio listing and portfolio detail pages
+- Contact form submission by email
+- Global site configuration stored in
+
+`AppConfig`
+
+- Media library management
+- Portfolio content management
+- Maintenance mode
+
+## Current Implementation
+
+### Public site
+
+- Localized routes for
+
+`de`
+
+,
+
+`en`
+
+,
+
+`ar`
+
+- Main pages:
+
+`/`
+
+,
+
+`/about`
+
+,
+
+`/portfolio`
+
+,
+
+`/portfolio/category/[slug]`
+
+,
+
+`/portfolio/[slug]`
+
+,
+
+`/contact`
+
+,
+
+`/success`
+
+,
+
+`/coming-soon`
+
+- Header includes a disabled
+
+`/products`
+
+navigation item marked as
+
+`Soon`
+
+### Admin workspace
+
+- Login protected by Basic Auth at middleware level and password session inside the app
+- Dedicated sections for:
+  - Overview
+  - Maintenance
+  - UI Kit
+  - Media Library
+  - Site Settings
+  - Marquee Settings
+  - SMTP Settings
+  - Contact Protection
+  - Portfolio management
+
+### Data model
+
+Current persistent entities in
+
+`prisma/schema.prisma`
+
+:
+
+- `AppConfig`
+- `Category`
+- `PortfolioProject`
+- `PortfolioSection`
+- `PortfolioAsset`
+- `MediaAsset`
+- `MediaUsage`
+
+No current models exist for:
+
+- `Product`
+- `Order`
+- `Download`
+- `ProjectInquiry`
+
+## Recommended Improvements
+
+- Replace the placeholder
+
+`README.md`
+
+with project-specific onboarding
+- Add explicit domain documentation for current
+
+`portfolio`
+
+versus planned future commerce features
+- Add persistent storage for inbound contact and inquiry submissions if auditability is required
+- Add role separation if the
+
+`admin`
+
+area will be used by more than one operator