5cc4e0fc0a
This commit introduces a comprehensive document outlining the KROW Workforce Platform project, covering vision, architecture, domain logic, feature gap analysis, and development strategy. The document serves as a central source of truth for team onboarding and sprint planning, ensuring alignment and consistency across the project. It details the migration from a legacy system to a new GCP-based architecture using Firebase Data Connect, Cloud Functions, and Cloud SQL. Key aspects covered include: - Project vision and business value proposition - System architecture and technology stack comparison - Core domain logic and entity definitions - Feature gap analysis between legacy and prototype apps - Data Connect schema evolution and development strategy - Definition of Done (DoD) for features and sprints The document also includes appendices with entity relationship summaries, status enum references, and key file locations.
KROW Workforce Monorepo
KROW is a comprehensive workforce management platform designed to streamline operations for events, hospitality, and enterprise staffing. This monorepo contains all components of the ecosystem, from the data layer to the user-facing applications.
🚀 Repository Structure
📦 Apps (/apps)
These are the production-ready applications for our users:
web-dashboard/: The primary React/Vite dashboard for Admin, Vendors, and Clients.mobile-client/: Flutter application for final clients to manage orders and billing.mobile-staff/: Flutter application for staff members (scheduling, clock-in/out, earnings).
⚙️ Backend (/backend)
The core data engine powering all applications:
dataconnect/: Firebase Data Connect configuration, GraphQL schemas (PostgreSQL), and auto-generated SDKs.
🛠️ Internal (/internal)
Tools and resources for the development and operations team:
launchpad/: A secure portal (DevOps Launchpad) to access internal resources, documentation, and infrastructure links.api-harness/: A technical tool for testing and validating the Data Connect API and Cloud Functions.prototypes/: Reference code and visual prototypes (synchronized from external sources).
📂 Support Directories
/docs: Project vision, technical specifications, and guides./makefiles: ModularizedMakefilelogic for project automation./scripts: Automation scripts (security, hachage, environment setup)./firebase: Global Firebase configuration (Firestore/Storage rules).
🛠️ Tech Stack
- Frontend: React (Vite)
- Mobile: Flutter
- Backend: Firebase (Data Connect, Auth, Hosting, Functions)
- Database: PostgreSQL (managed via Cloud SQL & Data Connect)
- Infrastructure: Google Cloud Platform (GCP)
📦 Getting Started
This project uses a modular Makefile for all common tasks.
-
View available commands:
make help -
Install dependencies (Web):
make install -
Run the Web Dashboard locally:
make dev -
Run the DevOps Launchpad locally:
make launchpad-dev
📚 Documentation
- 00-vision.md: Project objectives and guiding principles.
- 01-backend-api-specification.md: (Legacy) Reference for data schemas.
- 02-codemagic-env-vars.md: Guide for CI/CD environment variables.
- 03-contributing.md: Guidelines for new developers and setup checklist.
- 04-sync-prototypes.md: How to sync prototypes for local dev and AI context.
🤝 Contributing
New to the team? Please read our Contributing Guide to get your environment set up and understand our workflow.
© 2026 KROW Workforce / Oloodi Technologies Inc.