replace the "Krow" with "KROW"
This commit is contained in:
@@ -1,11 +1,11 @@
|
||||
# Krow System Architecture Overview
|
||||
# KROW System Architecture Overview
|
||||
|
||||
## 1. System Purpose: The Digital Workforce Marketplace
|
||||
The **Krow Ecosystem** is a complete digital solution for the temporary staffing industry. Its primary purpose is to seamlessly connect two groups of people:
|
||||
The **KROW Ecosystem** is a complete digital solution for the temporary staffing industry. Its primary purpose is to seamlessly connect two groups of people:
|
||||
1. **Businesses** (restaurants, event venues) who need temporary staff.
|
||||
2. **Workers** (waiters, security, chefs) who are looking for flexible shifts.
|
||||
|
||||
Instead of using agencies, phone calls, or spreadsheets, the Krow system automates the entire process: finding staff, verifying their skills, tracking their work hours on-site, and processing payments. It turns a chaotic manual process into a smooth, transparent digital workflow.
|
||||
Instead of using agencies, phone calls, or spreadsheets, the KROW system automates the entire process: finding staff, verifying their skills, tracking their work hours on-site, and processing payments. It turns a chaotic manual process into a smooth, transparent digital workflow.
|
||||
|
||||
## 2. The Role of Each Application
|
||||
The system is composed of three distinct applications, each tailored for a specific user:
|
||||
@@ -21,8 +21,8 @@ The system is composed of three distinct applications, each tailored for a speci
|
||||
* **Key Analogy:** Like the "Uber Driver" app—accepting jobs and proving the work was done.
|
||||
|
||||
### C. The Web Platform (Web & Backend)
|
||||
* **User:** Krow Operations Team (Admins) & System Logic.
|
||||
* **Role:** The "Brain" and "Control Tower." It stores all the data, enforces the rules (e.g., "You can't work if your visa is expired"), and provides a dashboard for Krow staff to oversee the entire business.
|
||||
* **User:** KROW Operations Team (Admins) & System Logic.
|
||||
* **Role:** The "Brain" and "Control Tower." It stores all the data, enforces the rules (e.g., "You can't work if your visa is expired"), and provides a dashboard for KROW staff to oversee the entire business.
|
||||
* **Key Analogy:** The Uber HQ dashboard—managing the market, resolving disputes, and ensuring safety.
|
||||
|
||||
## 3. How They Interact
|
||||
@@ -50,14 +50,14 @@ To keep the system fast, secure, and reliable, all three apps share a common fou
|
||||
The system uses a strict **Role-Based Access Control (RBAC)** model:
|
||||
* **Authentication (Who are you?):** Handled by Firebase. Every request to the server must include a digital "ID Card" (Token) proving the user is logged in.
|
||||
* **Authorization (What can you do?):** Handled by the Web Platform. Even if a Staff member tries to "hack" the app to ask for an Invoice, the Server will check their role, see they are "Staff" (not "Client"), and block the request immediately.
|
||||
* **Verification Gates:** The system includes human-in-the-loop security. A staff member cannot just sign up and work; they enter a "Pending" state until a Krow Admin manually reviews their documents on the Web Platform.
|
||||
* **Verification Gates:** The system includes human-in-the-loop security. A staff member cannot just sign up and work; they enter a "Pending" state until a KROW Admin manually reviews their documents on the Web Platform.
|
||||
|
||||
## 7. Critical Dependencies
|
||||
The ecosystem relies on the **Web Platform** being online.
|
||||
* **If the Staff App fails:** Only workers are affected.
|
||||
* **If the Client App fails:** Only businesses are affected.
|
||||
* **If the Web Platform fails:** The entire system stops. No new shifts can be posted, no one can apply, and real-time clock-ins might fail (though the apps have some offline safeguards).
|
||||
* **3rd Party Reliance:** The system depends on **Firebase** (for login) and **Payment Gateways** (to move money). If these global services go down, Krow's ability to log users in or pay them will pause.
|
||||
* **3rd Party Reliance:** The system depends on **Firebase** (for login) and **Payment Gateways** (to move money). If these global services go down, KROW's ability to log users in or pay them will pause.
|
||||
|
||||
## 8. Overview Diagram
|
||||
```mermaid
|
||||
@@ -75,7 +75,7 @@ flowchart LR
|
||||
StaffApp["Staff Mobile App<br/>(Workers)"]:::staffApp
|
||||
end
|
||||
|
||||
subgraph Core_Platform["Krow Web Platform"]
|
||||
subgraph Core_Platform["KROW Web Platform"]
|
||||
direction TB
|
||||
AdminPanel["Admin Dashboard<br/>(Operations Team)"]:::backend
|
||||
APIServer["Central API Server<br/>(GraphQL Logic)"]:::backend
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Application Overview: Krow Client Mobile App
|
||||
# Application Overview: KROW Client Mobile App
|
||||
|
||||
## 1. Executive Summary
|
||||
The **Krow Client App** is a mobile workforce management tool designed for business owners and managers. Think of it as a "control center" that allows businesses to easily hire, manage, and pay temporary staff for events or shifts.
|
||||
The **KROW Client App** is a mobile workforce management tool designed for business owners and managers. Think of it as a "control center" that allows businesses to easily hire, manage, and pay temporary staff for events or shifts.
|
||||
|
||||
Instead of calling agencies or managing spreadsheets, a business user opens this app to:
|
||||
* Define a job (Event/Shift).
|
||||
@@ -11,10 +11,10 @@ Instead of calling agencies or managing spreadsheets, a business user opens this
|
||||
* Handle payments and invoices.
|
||||
|
||||
## 2. High-Level Architecture
|
||||
The application follows a **Modern Mobile Architecture** designed for reliability and speed. It acts as a "smart interface" that connects the user to the central Krow platform.
|
||||
The application follows a **Modern Mobile Architecture** designed for reliability and speed. It acts as a "smart interface" that connects the user to the central KROW platform.
|
||||
|
||||
* **The Frontend (This App):** Handles everything the user sees and touches. It validates inputs (like ensuring a shift end time is after the start time) and displays data beautifully.
|
||||
* **The Bridge (API Layer):** The app talks to the Krow Cloud Server using **GraphQL**. This allows the app to ask for exactly the data it needs—no more, no less—making it fast even on slower connections.
|
||||
* **The Bridge (API Layer):** The app talks to the KROW Cloud Server using **GraphQL**. This allows the app to ask for exactly the data it needs—no more, no less—making it fast even on slower connections.
|
||||
* **The Backend (The Brain):** All heavy processing (matching staff to jobs, processing payments) happens on the secure server, not on the phone.
|
||||
|
||||
## 3. Major Components & Modules
|
||||
@@ -45,9 +45,9 @@ These modules contain the specific business logic and UI for each distinct part
|
||||
## 5. External System Communication
|
||||
The app does not live in isolation; it talks to several outside services:
|
||||
|
||||
* **The Krow Backend (GraphQL):** The primary source of truth for all data (Events, Staff profiles, Shifts).
|
||||
* **Firebase Auth:** Handles secure login (passwords, email verification) so the Krow team doesn't have to build security from scratch.
|
||||
* **Firebase Remote Config:** Allows the Krow team to change app settings (like feature flags or text) without forcing users to update the app.
|
||||
* **The KROW Backend (GraphQL):** The primary source of truth for all data (Events, Staff profiles, Shifts).
|
||||
* **Firebase Auth:** Handles secure login (passwords, email verification) so the KROW team doesn't have to build security from scratch.
|
||||
* **Firebase Remote Config:** Allows the KROW team to change app settings (like feature flags or text) without forcing users to update the app.
|
||||
* **NFC Services:** Interacts with physical NFC tags, likely for scanning staff badges or verifying presence at a location.
|
||||
* **Geolocation Services:** Uses the phone's GPS to verify that actions (like creating a hub) are happening at the correct physical address.
|
||||
|
||||
@@ -109,7 +109,7 @@ flowchart TD
|
||||
|
||||
subgraph External_Services [External Cloud Ecosystem]
|
||||
direction TB
|
||||
Krow_Backend[Krow Backend Server]:::external
|
||||
Krow_Backend[KROW Backend Server]:::external
|
||||
Firebase[Firebase Auth & Config]:::external
|
||||
Maps_NFC[Geolocation & NFC Services]:::external
|
||||
end
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Use Case Documentation: Krow Client Mobile App
|
||||
# Use Case Documentation: KROW Client Mobile App
|
||||
|
||||
## 1. App Initialization
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Application Overview: Krow Staff Mobile App
|
||||
# Application Overview: KROW Staff Mobile App
|
||||
|
||||
## 1. Executive Summary
|
||||
The **Krow Staff App** is the mobile companion for the workforce—the people picking up shifts and performing the work. It operates as a "gig economy" platform where individuals can find flexible work, manage their schedule, and track their income.
|
||||
The **KROW Staff App** is the mobile companion for the workforce—the people picking up shifts and performing the work. It operates as a "gig economy" platform where individuals can find flexible work, manage their schedule, and track their income.
|
||||
|
||||
For a staff member (e.g., a waiter, chef, or event security), this app is their digital office. They use it to:
|
||||
* Browse and apply for available shifts in their area.
|
||||
@@ -14,7 +14,7 @@ For a staff member (e.g., a waiter, chef, or event security), this app is their
|
||||
Like the Client App, this application is built on a **Modern Mobile Architecture** that prioritizes offline resilience and real-time accuracy.
|
||||
|
||||
* **The Frontend (The App):** A polished, user-friendly interface that guides staff through complex workflows (like onboarding or shift execution) simply.
|
||||
* **The Bridge (API Layer):** Communicates with the Krow Cloud via **GraphQL**, allowing the app to fetch personalized job feeds and update work status efficiently.
|
||||
* **The Bridge (API Layer):** Communicates with the KROW Cloud via **GraphQL**, allowing the app to fetch personalized job feeds and update work status efficiently.
|
||||
* **The Backend (The Engine):** Manages the "marketplace" logic—matching staff skills to event requirements, calculating pay rates, and processing compliance rules.
|
||||
|
||||
## 3. Major Components & Modules
|
||||
@@ -43,7 +43,7 @@ These modules handle the specific tasks a staff member needs to perform:
|
||||
* **Data Repository:** intelligent data handling. It knows when to fetch new jobs from the internet and when to show the saved schedule from the local database (crucial for venues with poor reception).
|
||||
|
||||
## 5. External System Communication
|
||||
* **The Krow Backend (GraphQL):** The central authority for job listings, user profiles, and time/attendance records.
|
||||
* **The KROW Backend (GraphQL):** The central authority for job listings, user profiles, and time/attendance records.
|
||||
* **Firebase Auth:** Secure identity management for login and signup.
|
||||
* **Firebase Remote Config:** Allows dynamic updates to app behavior (e.g., maintenance mode messages).
|
||||
* **Geolocation & Maps:** Verifies that the staff member is physically at the venue when clocking in and provides directions to the job site.
|
||||
@@ -107,7 +107,7 @@ flowchart TD
|
||||
|
||||
subgraph External_Services [External Cloud Ecosystem]
|
||||
direction TB
|
||||
Krow_Backend[Krow Backend Server]:::external
|
||||
Krow_Backend[KROW Backend Server]:::external
|
||||
Firebase[Firebase Auth & Config]:::external
|
||||
Geo_Maps[Geolocation & Maps]:::external
|
||||
Hardware[Camera & NFC Hardware]:::external
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Use Case Documentation: Krow Staff Mobile App
|
||||
# Use Case Documentation: KROW Staff Mobile App
|
||||
|
||||
## 1. App Initialization
|
||||
|
||||
@@ -61,7 +61,7 @@
|
||||
## 5. Admin Verification
|
||||
|
||||
* **Primary Actor:** Staff Member (Passive) / Admin
|
||||
* **Description:** The waiting state while Krow admins review the submitted profile.
|
||||
* **Description:** The waiting state while KROW admins review the submitted profile.
|
||||
* **Preconditions:** Profile submitted.
|
||||
* **Main Flow:**
|
||||
1. User sees "Waiting for Admin Review" screen.
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
# Krow Legacy Ecosystem: System Bible
|
||||
# KROW Legacy Ecosystem: System Bible
|
||||
|
||||
**Status:** Official System Constitution
|
||||
**Version:** 1.0.0
|
||||
**Date:** 2026-02-06
|
||||
**Scope:** Krow Legacy Ecosystem (Client App, Staff App, Web Platform)
|
||||
**Scope:** KROW Legacy Ecosystem (Client App, Staff App, Web Platform)
|
||||
|
||||
---
|
||||
|
||||
## 1. Executive Summary
|
||||
|
||||
The **Krow Legacy Ecosystem** is a comprehensive digital marketplace designed to revolutionize the temporary staffing industry. It eliminates the friction of traditional agencies by directly connecting **businesses** (restaurants, event organizers) with **temporary workers** (wait staff, security, chefs) through a unified, automated platform.
|
||||
The **KROW Legacy Ecosystem** is a comprehensive digital marketplace designed to revolutionize the temporary staffing industry. It eliminates the friction of traditional agencies by directly connecting **businesses** (restaurants, event organizers) with **temporary workers** (wait staff, security, chefs) through a unified, automated platform.
|
||||
|
||||
**Why It Exists:**
|
||||
The traditional staffing model is slow, opaque, and manual (spreadsheets, phone calls). This ecosystem digitizes the entire lifecycle—from finding staff and verifying their skills to tracking attendance and processing payments—creating a transparent, efficient market for flexible work.
|
||||
@@ -88,7 +88,7 @@ flowchart TD
|
||||
StaffApp["Staff App<br/>(Workers)"]:::staffApp
|
||||
end
|
||||
|
||||
subgraph Core_Platform["Krow Web Platform"]
|
||||
subgraph Core_Platform["KROW Web Platform"]
|
||||
direction TB
|
||||
AdminPanel["Admin Dashboard<br/>(Laravel Nova)"]:::backend
|
||||
APIServer["GraphQL API<br/>(Laravel Lighthouse)"]:::backend
|
||||
@@ -229,7 +229,7 @@ These are the officially recognized system workflows.
|
||||
* **Shift:** A specific time block requiring a worker (e.g., "Friday 18:00-22:00").
|
||||
* **Position:** A specific role required for a shift (e.g., "Head Waiter").
|
||||
* **Clock-In:** The digital act of starting work, verified by location and time.
|
||||
* **Admin Panel:** The web interface for Krow operations staff.
|
||||
* **Admin Panel:** The web interface for KROW operations staff.
|
||||
* **Marketplace:** The collection of all open, unassigned shifts visible to staff.
|
||||
* **BLoC:** (Business Logic Component) The code pattern used in the mobile apps to manage state.
|
||||
* **GraphQL:** The data query language used for API communication.
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
# Application Overview: Krow Web Platform (Backend)
|
||||
# Application Overview: KROW Web Platform (Backend)
|
||||
|
||||
## 1. Executive Summary
|
||||
The **Krow Web Platform** is the central "brain" and "command center" of the entire Krow ecosystem. While the mobile apps are the tools used in the field, this web application is the engine that powers them.
|
||||
The **KROW Web Platform** is the central "brain" and "command center" of the entire KROW ecosystem. While the mobile apps are the tools used in the field, this web application is the engine that powers them.
|
||||
|
||||
It serves two primary functions:
|
||||
1. **The Engine:** It processes all data from the mobile apps—saving new events, finding available staff, handling payments, and verifying check-ins.
|
||||
2. **The Control Tower (Admin Panel):** It provides a powerful website where Krow administrators can oversee the entire business, manage users, resolve disputes, and configure system-wide settings.
|
||||
2. **The Control Tower (Admin Panel):** It provides a powerful website where KROW administrators can oversee the entire business, manage users, resolve disputes, and configure system-wide settings.
|
||||
|
||||
## 2. High-Level Architecture
|
||||
The application follows a **Monolithic Web Architecture** using the **Laravel** framework. This is a battle-tested, robust structure ideal for building complex, data-heavy business platforms.
|
||||
@@ -84,7 +84,7 @@ flowchart TD
|
||||
classDef data fill:#e8f5e9,stroke:#2e7d32,stroke-width:2px,color:#1b5e20
|
||||
classDef external fill:#f3e5f5,stroke:#7b1fa2,stroke-width:2px,color:#4a148c
|
||||
|
||||
subgraph Server_Application [Krow Web Platform]
|
||||
subgraph Server_Application [KROW Web Platform]
|
||||
direction TB
|
||||
|
||||
subgraph Interfaces [Access Layers]
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# Use Case Documentation: Krow Web Platform (Admin Panel)
|
||||
# Use Case Documentation: KROW Web Platform (Admin Panel)
|
||||
|
||||
## 1. Admin Login
|
||||
|
||||
|
||||
Reference in New Issue
Block a user