Source document · README.md

SB Relaxing Club

SB Relaxing Club is a service marketplace and community platform for iOS, Android, and the web administration team. Customers discover and book local services, providers manage businesses and orders, members use community features, and platform staff manage operations and reporting.

Repository map

Directory	Purpose	Start here
`Planning/`	Product scope, business rules, roles, and acceptance baseline	Project SRS
`API/`	Go backend, API contract, database migrations, and operations docs	API README
`admin/`	Next.js admin dashboard for platform operations	Admin README
`Mobile-app/`	Kotlin Multiplatform mobile requirements and future implementation	Mobile README
`docs/`	Nextra documentation website that presents synchronized project documents	Docs README

System at a glance


Kotlin Multiplatform mobile app       Next.js admin webapp
                 \                     /
                  \                   /
                    Go API
                 /    |     \
        PostgreSQL  Object   Realtime and jobs
                    storage

The Go API is the authority for authentication, permissions, prices, order and payment state, notifications, reporting, and audit records. Mobile and admin clients render state and submit intent; they do not reproduce backend rules as an independent source of truth.

Documentation order

For a complete understanding, read in this order:

Project SRS — what the product must do.
API SRS — how the backend must behave.
API domain glossary — exact meaning of important terms.
Mobile SRS — how Android and iOS present the product.
Repository READMEs and architecture notes — how each codebase is organized and maintained.

Documentation website


cd docs
npm install
npm run dev

Open http://localhost:3000/. The docs site is deployed at its own Vercel domain, separate from the Go API host. The pre-development and pre-build commands synchronize the source Markdown into the deployable documentation site.

Admin dashboard

Run the Go API first, then start the admin site:


cd admin
npm install
cp .env.example .env.local
npm run dev

Open http://localhost:3001. Admin access uses the API email OTP flow and is limited to administrators and accountants. Accountant reporting is scoped to service assignments managed by administrators.

Documentation maintenance rule

Documentation is part of implementation work. A change is incomplete when it changes behavior, a public contract, domain vocabulary, setup, configuration, or architecture without updating the owning document.

Product behavior changes update Planning/SB_Relaxing_Club_Project_SRS.md.
API contract or backend architecture changes update API/API_SRS.md, API/CONTEXT.md, and OpenAPI when it exists.
Mobile behavior or architecture changes update Mobile-app/MOBILE_APP_SRS.md and its architecture notes.
Repository setup changes update that repository’s README.md.
Material documentation changes add an entry to the relevant docs/CHANGELOG.md.
Run npm run docs:check in docs/ to verify synchronized site content and route parity.

Current status

The product/API documentation, Go API, mobile application, documentation site, and Next.js admin site are in the shared workspace. API endpoints and admin screens continue to grow against the documented release scope; check each repository README for current implementation status and known gaps.