docs: restructure server and web documentation into ADR files and a

routing table
2026-07-17 22:07:55 +08:00
parent f8494a44ca
commit 519aa35f1f
23 changed files with 710 additions and 654 deletions
@@ -0,0 +1,27 @@
+# ADR-0001: Select the Server Foundation
+
+Status: Accepted  
+Date: 2026-04-25
+
+## Context
+
+MyGO needed a server stack that supports local development, relational metadata, configurable deployment, and multiple file storage backends.
+
+## Decision
+
+- Use Gin for HTTP routing and middleware.
+- Use GORM with SQLite and PostgreSQL drivers.
+- Use Viper for YAML and environment configuration, with a Cobra flag for the config file path.
+- Use local file storage first and expose storage through `internal/storage`.
+- Use UUIDs for file and domain identities.
+- Use JWT access tokens and database-backed refresh sessions.
+- Use offset and limit pagination for the initial API.
+- Return direct JSON success bodies and a shared JSON error shape.
+- Organize the server as Handler -> Service -> Repository and Storage.
+
+## Consequences
+
+- SQLite supports a zero-service local setup; PostgreSQL supports multi-instance deployments.
+- Repository and storage interfaces isolate infrastructure choices from services.
+- Database-backed refresh sessions support rotation and revocation.
+- Offset pagination remains suitable for the current dataset size and API scope.