3c0488576b
This commit restructures the monorepo to improve organization, maintainability, and scalability. The changes include: - Moving mobile apps from `mobile-apps/` to `apps/mobile-*`. - Moving the web dashboard from `admin-web/` and `frontend-web/` to `apps/web-dashboard/`. - Moving Firebase-related files to the root `firebase/` directory. - Adding a `.geminiignore` file to exclude unnecessary files from Gemini analysis. - Updating `.gitignore` to reflect the new structure and exclude sensitive files. - Updating `codemagic.yaml` to reflect the new app locations. - Adding a `make help` command to the root directory. - Adding a `make install-git-hooks` command to install git hooks. - Adding a `docs/02-codemagic-env-vars.md` file to document Codemagic environment variables. - Adding a `docs/03-contributing.md` file to document contribution guidelines. - Adding prototype placeholders to the internal launchpad. - Updating the `README.md` file to reflect the new structure and provide updated instructions. These changes improve the overall structure of the monorepo and make it easier to develop, maintain, and scale the KROW Workforce platform.
71 lines
2.9 KiB
Markdown
71 lines
2.9 KiB
Markdown
# 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`**: Modularized `Makefile` logic 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.
|
|
|
|
1. **View available commands:**
|
|
```bash
|
|
make help
|
|
```
|
|
|
|
2. **Install dependencies (Web):**
|
|
```bash
|
|
make install
|
|
```
|
|
|
|
3. **Run the Web Dashboard locally:**
|
|
```bash
|
|
make dev
|
|
```
|
|
|
|
4. **Run the DevOps Launchpad locally:**
|
|
```bash
|
|
make launchpad-dev
|
|
```
|
|
|
|
## 📚 Documentation
|
|
- **[00-vision.md](./docs/00-vision.md)**: Project objectives and guiding principles.
|
|
- **[01-backend-api-specification.md](./docs/01-backend-api-specification.md)**: (Legacy) Reference for data schemas.
|
|
- **[02-codemagic-env-vars.md](./docs/02-codemagic-env-vars.md)**: Guide for CI/CD environment variables.
|
|
- **[03-contributing.md](./docs/03-contributing.md)**: Guidelines for new developers and setup checklist.
|
|
|
|
## 🤝 Contributing
|
|
New to the team? Please read our **[Contributing Guide](./docs/03-contributing.md)** to get your environment set up and understand our workflow.
|
|
|
|
---
|
|
© 2026 KROW Workforce / Oloodi Technologies Inc.
|