Achintha Isuru 5a5b8894c4 docs: update README and project onboarding for M4 milestone
Updated README with logo and M4 status. Updated project onboarding doc to version 2.0 with M4 features, release automation, and architecture updates.
2026-03-06 15:36:57 -05:00
2026-01-10 21:22:35 -05:00
2026-03-04 14:29:28 -05:00
2026-02-04 11:56:19 +05:30
2026-03-05 15:31:50 -05:00

KROW Logo

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.

📍 Current Status

Latest Milestone: M4 (Released: March 5, 2026)

  • Staff Mobile App: v0.0.1-m4
  • Client Mobile App: v0.0.1-m4
  • 🚀 Full profile management with documents & certificates
  • 🚀 Enhanced session management and Core API integration
  • 🚀 Automated GitHub Actions workflows for releases

🚀 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/: Flutter applications for client and staff.
  • client: The application for final clients to manage orders and billing.
  • staff: The 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: Modularized Makefile logic for project automation.
  • /scripts: Automation scripts (security, hachage, environment setup).
  • /firebase: Global Firebase configuration (Firestore/Storage rules).
  • /.github: GitHub Actions workflows for CI/CD and release automation.

🛠️ 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.

  1. View available commands:

    make help
    
  2. Install dependencies (Web):

    make install
    
  3. Run the Web Dashboard locally:

    make dev
    
  4. Run the DevOps Launchpad locally:

    make launchpad-dev
    
  5. Mobile app development:

    cd apps/mobile
    flutter pub get
    melos bootstrap
    flutter run  # Select device
    

🚀 Release Process

Mobile App Releases

We use GitHub Actions for automated mobile releases:

  • Standard Release: Trigger Product Release workflow

    • Auto-extracts version from pubspec.yaml
    • Creates Git tags: krow-withus-<app>-mobile/<env>-vX.Y.Z
    • Generates GitHub Release with CHANGELOG
    • Builds and signs APK (dev/stage/prod keystores)
  • Hotfix Release: Trigger Hotfix Branch Creation workflow

    • Auto-increments PATCH version
    • Updates pubspec.yaml and CHANGELOG.md
    • Creates PR with fix instructions

See: Mobile Release Documentation for complete guide.

📚 Documentation

Core Documentation

Mobile Development Documentation

Release Documentation

  • RELEASE/mobile-releases.md: Comprehensive mobile release guide with versioning, CHANGELOGs, GitHub Actions workflows, and APK signing.

CHANGELOGs

🤝 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.

Description
No description provided
Readme 25 MiB
Languages
Dart 56.5%
JavaScript 20.8%
TypeScript 11.8%
Python 2.2%
C++ 2%
Other 6.7%