A lightweight, server-rendered clan ERP and management dashboard designed for a War Thunder and Arma 3 gaming community. The system tracks member lifecycle history, community nicknames, core/section ranks, awards, and multi-platform account associations over time.
- Member Management: Tracks community members, lifecycle events (joins, leaves, kicks), rank changes, awards, and statuses.
- Multi-Platform Accounts: Distinguishes concepts of member identity from external platform and game accounts - supporting Discord, War Thunder, Arma 3 Units and Steam.
- History Tracking: Preserves historical records for anything that changes over time (nicknames, ranks, platform linkages and relations).
- Source Auditability: Distinguishes manual administrative entries from automated data, with manual inputs taking priority.
- Role-Based Access: Secure, role-restricted dashboard access tailored for Owners, Administrators, and Members.
- Runtime & Package Manager: Bun (>= 1.4)
- Web Framework: Hono (Server-Side Rendering via Hono JSX)
- Database Query Builder: Kysely
- Database Driver:
pg(PostgreSQL running as a local Windows service) - UI Framework: Bootstrap 5 (loaded strictly via CDN)
- Installed Bun runtime (>= 1.4)
- Active local PostgreSQL instance (e.g. database
clan_management)
-
Clone the repository:
git clone https://github.com/7BOW-WGST/ClanManagementSystem cd ClanManagementSystem -
Install dependencies:
bun install
-
Configure the environment:
Copy
.env.exampleto.envand setDATABASE_URLto match your local PostgreSQL instance. -
Prepare the database:
bun run migrate bun run seed
-
Run the development server (Hot Reload):
bun run dev
Open
http://localhost:3000. Usebun run testto run the test suite.
| Command | Purpose |
|---|---|
bun run dev |
Development server with hot reload |
bun run start |
Start the server once |
bun run migrate |
Apply database migrations |
bun run seed |
Seed catalog data (sections) |
bun run test |
Run tests (bun:test) |
bun run typecheck |
Type-check the project |
AI-assisted and human contributions are governed by strict project standards:
AGENTS.md- Source of truth for coding standards, serving AI assistants and human contributors.docs/development/- Development documentation:REQUIREMENTS.md- Product requirements, domain concepts, and phasing.DECISIONS.md- Domain-model and architecture decisions.DATA_MODEL.md- Database design dictionary.CATALOGS.md- Rank and award catalog definitions.ACCEPTANCE.md- Acceptance criteria and example histories.ROADMAP.md- Implementation milestones and vertical slices.
CONTRIBUTING.md- Contribution rules and git workflow guidelines.