Skip to content

Add README.md - #69

Merged
KNPhilip merged 9 commits into
mainfrom
copilot/add-readme-documentation
Feb 27, 2026
Merged

KNPhilip merged 9 commits into
mainfrom
copilot/add-readme-documentation

Conversation

Copilot AI commented Feb 27, 2026 •

Copy link
Copy Markdown
Contributor

No README existed for the project — adds one covering everything needed to understand and run ActivityHive.

Contents

  • Overview & features — what the app does (activity management, attendance, social following, real-time comments, auth)
  • Tech stack — F# / ASP.NET Core 10 / EF Core / PostgreSQL / SignalR on the backend; React 18 / TypeScript / Vite / MobX on the frontend
  • Project structure — annotated directory tree mapping each layer (API, Application, Domain, Persistence, Infrastructure, client-app, tests)
  • Getting started — prerequisites, DB config, backend (dotnet run) and frontend (npm run dev) setup
  • Testing — unit, integration, and full-suite commands
  • API reference table — all REST endpoints + SignalR WebSocket
  • Docker & Fly.io deployment — build/run commands with required environment variables

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: KNPhilip <107537536+KNPhilip@users.noreply.github.com>
Copilot AI changed the title [WIP] Add README to explain project details Add README.md Feb 27, 2026
@KNPhilip
KNPhilip marked this pull request as ready for review February 27, 2026 22:47
@KNPhilip
KNPhilip merged commit 1268221 into main Feb 27, 2026
1 check passed
@KNPhilip
KNPhilip deleted the copilot/add-readme-documentation branch February 27, 2026 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants