65 lines
1.4 KiB
Markdown
65 lines
1.4 KiB
Markdown
# HemHub
|
|
|
|
HemHub är en webbapplikation för hantering av uppgifter i ett hushåll. Repositoryt
|
|
innehåller två separata applikationer:
|
|
|
|
- en backend byggd med Java 21, Spring Boot och Maven
|
|
- en frontend byggd med React, TypeScript, Vite och pnpm
|
|
|
|
Backend använder en lokal filbaserad H2-databas i `backend/data`. Databasschemat
|
|
hanteras med Flyway. Databasfilerna är lokala och ignoreras av Git.
|
|
|
|
API:t innehåller endpoints under `/api/users` för användare och `/api/tasks` för
|
|
att skapa och lista gemensamma hushållsuppgifter.
|
|
|
|
## Starta backend
|
|
|
|
Backend startar på port 8080.
|
|
|
|
```bash
|
|
cd backend
|
|
./mvnw spring-boot:run
|
|
```
|
|
|
|
## Starta frontend
|
|
|
|
Frontend startar normalt på port 5173. Vites utvecklingsserver proxar anrop under
|
|
`/api` till backend på `http://localhost:8080`.
|
|
|
|
```bash
|
|
cd frontend
|
|
pnpm install
|
|
pnpm dev
|
|
```
|
|
|
|
Öppna sedan <http://localhost:5173>.
|
|
|
|
## Köra tester
|
|
|
|
Backend:
|
|
|
|
```bash
|
|
cd backend
|
|
./mvnw test
|
|
```
|
|
|
|
Frontend:
|
|
|
|
```bash
|
|
cd frontend
|
|
pnpm test
|
|
```
|
|
|
|
## Dokumentation
|
|
|
|
Projektets aktuella arkitektur, utvecklingsprocess, övergripande beslut och
|
|
featurehistorik finns i [`docs/`](docs/):
|
|
|
|
- [arkitektur](docs/architecture.md)
|
|
- [roadmap och planerad featureordning](docs/roadmap.md)
|
|
- [utvecklingsprocess](docs/development.md)
|
|
- [arkitekturbeslut](docs/decisions/)
|
|
- [implementerade features](docs/features/)
|
|
|
|
Dokumentationen ska uppdateras tillsammans med implementation och tester.
|