Krow/Krow-workspace
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: doc 05 updated with some changes

Browse Source
This commit is contained in:
Achintha Isuru
2026-01-12 17:26:43 -05:00
parent 8916a4ac49
commit 7d61997373
1 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/05-project-onboarding-master.md
View File

@@ -171,7 +171,7 @@ graph TB
├── apps/ ├── apps/
│ ├── web-dashboard/ # Vite + React │ ├── web-dashboard/ # Vite + React
│ ├── mobile-client/ # Flutter (business app) │ ├── mobile-client/ # Flutter (business app)
│ └── mobile-staff/ # Flutter (worker app) │ └── mobile-worker/ # Flutter (worker app)
├── backend/ ├── backend/
│ ├── dataconnect/ # Firebase Data Connect schemas │ ├── dataconnect/ # Firebase Data Connect schemas
│ └── functions/ # Cloud Functions │ └── functions/ # Cloud Functions
@@ -310,7 +310,7 @@ sequenceDiagram
participant Client as Client App participant Client as Client App
participant API as Backend API participant API as Backend API
participant Admin as Admin participant Admin as Admin
participant Staff as Staff App participant Staff as Worker App
Note over Client,API: 1. Event Creation Note over Client,API: 1. Event Creation
Client->>API: Create Event with Shifts & Positions Client->>API: Create Event with Shifts & Positions
@@ -318,10 +318,12 @@ sequenceDiagram
Client->>API: Publish Event Client->>API: Publish Event
API-->>Client: Event Published API-->>Client: Event Published
Note over Admin,API: 2. Staff Assignment opt 2. Staff Assignment (Optional)
Note over Admin,API: Optional Staff Assignment
Admin->>API: Assign Staff to Shift Admin->>API: Assign Staff to Shift
API-->>Admin: Assignment Confirmed API-->>Admin: Assignment Confirmed
API->>Staff: Notification: New Shift API->>Staff: Notification: New Shift
end
Note over Staff,API: 3. Shift Acceptance Note over Staff,API: 3. Shift Acceptance
Staff->>API: Accept Shift Staff->>API: Accept Shift
@@ -337,6 +339,7 @@ sequenceDiagram
Client->>API: Rate Staff Client->>API: Rate Staff
API->>API: Generate Invoice API->>API: Generate Invoice
Client->>API: Approve Invoice Client->>API: Approve Invoice
``` ```
#### Workflow 2: Staff Onboarding #### Workflow 2: Staff Onboarding
@@ -370,6 +373,12 @@ sequenceDiagram
└── Status: completed_profile → verified └── Status: completed_profile → verified
``` ```
But there is an ambiguity in the workflow. In the legacy application, worker verification happens at the beginning, and all workers are fully verified before they can access the application. In the new version, however, workers are allowed to access the application without being fully verified. This creates ambiguity in the following areas:
- Definition of worker verification in the new system
- Does verification mean the worker has fully completed their profile, or can a worker be considered verified with an incomplete profile?
- Visibility of shifts for unverified workers
- Should unverified workers be able to view the shifts page?
#### Workflow 3: Payroll Calculation #### Workflow 3: Payroll Calculation
``` ```
@@ -695,7 +704,7 @@ These **must be ported** from legacy:
--- ---
#### 4.7.2 Mobile Staff App (Flutter) #### 4.7.2 Mobile Worker App (Flutter)
**Location:** `internal/launchpad/prototypes-src/mobile/staff/` **Location:** `internal/launchpad/prototypes-src/mobile/staff/`
@@ -797,9 +806,9 @@ These **must be ported** from legacy:
|-----------|----------|------| |-----------|----------|------|
| Web Prototype Source | `internal/launchpad/prototypes-src/web/` | React + TypeScript | | Web Prototype Source | `internal/launchpad/prototypes-src/web/` | React + TypeScript |
| Mobile Client Prototype | `internal/launchpad/prototypes-src/mobile/client/` | Flutter + Dart | | Mobile Client Prototype | `internal/launchpad/prototypes-src/mobile/client/` | Flutter + Dart |
| Mobile Staff Prototype | `internal/launchpad/prototypes-src/mobile/staff/` | Flutter + Dart | | Mobile Worker Prototype | `internal/launchpad/prototypes-src/mobile/worker/` | Flutter + Dart |
| Legacy Client Mobile | `_legacy/apps/krow_client_context.md` | Flutter (context doc) | | Legacy Client Mobile | `_legacy/apps/krow_client_context.md` | Flutter (context doc) |
| Legacy Staff Mobile | `_legacy/apps/krow_staff_context.md` | Flutter (context doc) | | Legacy Worker (Legacy Staff) Mobile | `_legacy/apps/krow_staff_context.md` | Flutter (context doc) |
| Legacy Backend | `_legacy/apps/php_backend_context.md` | PHP/Laravel | | Legacy Backend | `_legacy/apps/php_backend_context.md` | PHP/Laravel |
| New Backend | `backend/dataconnect/` | Firebase Data Connect | | New Backend | `backend/dataconnect/` | Firebase Data Connect |