docs: add project README

2026-10-03 18:30:50 +02:00
parent 3a45267ad8
commit 2158ad0ae6
1 changed files with 48 additions and 0 deletions
@@ -0,0 +1,48 @@
+# hubmi
+
+Platforma Małopolskiego Hubu Innowacji Społecznych (MVP hackathonu).
+
+- **backend/** — aplikacja backendowa w C# (ASP.NET Core, `HubMi.Api`).
+- **client/** — aplikacja frontendowa Vue 3 + TypeScript (Vite).
+- **scripts/** — skrypty budujące całość.
+- `HubMi.slnx` — solution .NET.
+
+## Wymagania
+
+- .NET SDK 10+
+- Node.js 22+ (npm)
+
+## Praca lokalna
+
+Backend (dev) nasłuchuje na `https://localhost:7080`.
+
+```pwsh
+# terminal 1 — backend
+dotnet run --project backend
+
+# terminal 2 — client (Vite, proxy /api -> http://localhost:5078)
+npm --prefix client install
+npm --prefix client run dev
+```
+
+## Skrypty
+
+```pwsh
+npm --prefix client run dev      # uruchamia Vite (dev server)
+npm --prefix client run build    # buduje aplikację Vite do client/dist
+npm --prefix client run copy     # kopiuje client/dist -> backend/wwwroot
+node scripts/build.mjs           # buduje całość (client + copy + backend)
+```
+
+## Struktura
+
+```
+hubmi/
+├─ backend/                 # ASP.NET Core Web API + wwwroot (build z client)
+├─ client/                  # Vue 3 + TS + Vite
+├─ scripts/
+│  ├─ build.mjs             # build całości
+│  └─ copy-client.mjs       # client/dist -> backend/wwwroot
+├─ HubMi.slnx
+└─ README.md
+```