replace the "Krow" with "KROW"

This commit is contained in:
Achintha Isuru
2026-02-26 15:13:26 -05:00
parent f9c2d822e6
commit b8d07380c0
60 changed files with 225 additions and 227 deletions

View File

@@ -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