docs: establish project documentation baseline
This commit is contained in:
76
docs/features/000-project-foundation.md
Normal file
76
docs/features/000-project-foundation.md
Normal file
@ -0,0 +1,76 @@
|
||||
# Feature 0 – Projektgrund
|
||||
|
||||
## Status
|
||||
|
||||
Färdig och mergad till `main`.
|
||||
|
||||
## Bakgrund
|
||||
|
||||
HemHub behövde en minimal projektgrund för inkrementell utveckling av en
|
||||
webbapplikation med separat frontend och backend.
|
||||
|
||||
## Mål
|
||||
|
||||
Skapa körbara React- och Spring Boot-applikationer, koppla ihop dem lokalt och
|
||||
etablera grundläggande tester och dokumentation.
|
||||
|
||||
## Omfattning
|
||||
|
||||
- monorepo med `backend/` och `frontend/`;
|
||||
- Java 21, Spring Boot och Maven Wrapper;
|
||||
- React, TypeScript, Vite och pnpm;
|
||||
- health-endpoint och en tillfällig frontendstatus;
|
||||
- Vite-proxy och grundtester;
|
||||
- `README.md`, `AGENTS.md` och `.gitignore`.
|
||||
|
||||
## Avgränsningar
|
||||
|
||||
Feature 0 införde ingen databas, domänmodell, autentisering, deployment,
|
||||
containerkonfiguration eller produktionskonfiguration.
|
||||
|
||||
## Beslut
|
||||
|
||||
Frontend och backend skapades som separata applikationer i samma repository.
|
||||
Frontend använder relativa `/api`-adresser, och Vite proxar dem lokalt till
|
||||
backend på port 8080. Ingen generell CORS-konfiguration infördes.
|
||||
|
||||
## Implementerad lösning
|
||||
|
||||
Backend skapades med Spring Boot 4.1.0, Java 21, Spring Web och Maven Wrapper.
|
||||
Frontend skapades med React 19, TypeScript, Vite och pnpm.
|
||||
|
||||
Den ursprungliga startsidan anropade health-endpointen och visade backendstatus
|
||||
eller ett anslutningsfel. Senare features har ersatt denna startsida, men
|
||||
health-endpointen och dess test finns kvar.
|
||||
|
||||
## API-förändringar
|
||||
|
||||
`GET /api/health` infördes och returnerar:
|
||||
|
||||
```json
|
||||
{"status":"UP"}
|
||||
```
|
||||
|
||||
## Databasförändringar
|
||||
|
||||
Inga.
|
||||
|
||||
## Frontendförändringar
|
||||
|
||||
En minimal startsida visade rubriken HemHub, att frontend hade startat och
|
||||
resultatet från `/api/health`. Vite konfigurerades att proxya `/api` till
|
||||
`http://localhost:8080`.
|
||||
|
||||
## Tester och verifiering
|
||||
|
||||
Ett MockMvc-test verifierar status 200 och `status: UP`. Det ursprungliga
|
||||
frontendtestet verifierade rubriken HemHub med mockat API-anrop.
|
||||
|
||||
## Kända begränsningar
|
||||
|
||||
Projektgrunden innehöll ingen användar- eller uppgiftsfunktionalitet. Den
|
||||
ursprungliga health-vyn är inte längre appens aktiva vy.
|
||||
|
||||
## Relaterade commits
|
||||
|
||||
- `9957383e88b08dc006d2eaeb2a513c7769bd5705` – `Initialize HemHub project foundation`
|
||||
Reference in New Issue
Block a user