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

feat(Makefile): add admin console commands to Makefile

Browse Source 
feat(README.md): update README to reflect monorepo structure and admin console
feat: remove setup_admin_console.sh script

The setup_admin_console.sh script is removed because the admin console setup is now integrated into the Makefile.
The README is updated to reflect the new monorepo structure and the admin console.
The Makefile is updated to include commands for installing, developing, and building the admin console.
This commit is contained in:
bwnyasse
2025-11-15 17:38:58 -05:00
parent 9db589d43f
commit 383fc14bf8
3 changed files with 70 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

87
README.md
View File

@@ -1,43 +1,38 @@
# KROW Workforce Platform
# Krow Workforce Management Platform
This monorepo contains the complete source code for the KROW Workforce platform, including the web frontend, mobile applications, and backend services.
Krow is a comprehensive monorepo platform designed to streamline workforce management for events, hospitality, and large-scale enterprise operations. It connects clients, operators, vendors, and staff in a unified ecosystem, leveraging modern technology to optimize every step from procurement to payroll.
## 🚀 What's in this Monorepo?
- **/firebase/**: Contains the Firebase Data Connect configuration (GraphQL schema, queries, mutations) and Firebase Hosting configuration.
- **/frontend-web/**: The React/Vite web application used by administrators and managers.
- **/mobile-apps/**: Contains the two Flutter-based mobile applications:
- `client-app`: For clients managing events.
- `staff-app`: For staff members managing their shifts and profile.
- **/docs/**: All project documentation (vision, roadmaps, architecture, guides).
- **/scripts/**: Automation scripts used by the `Makefile`.
- **/secrets/**: Contains sensitive credentials (ignored by Git).
- **/firebase/**: This directory is the backbone of our backend infrastructure. It contains:
- **Firestore Rules (`firestore.rules`):** Defines the security and access control logic for our NoSQL database, ensuring that users can only read and write data they are authorized to access.
- **Cloud Storage Rules (`storage.rules`):** Secures file uploads and downloads (like compliance documents and user avatars).
- **Data Connect (`dataconnect/`):** Houses the configuration for Firebase Data Connect, including the GraphQL schema, connectors, queries, and mutations that define our API layer.
## ▶️ Getting Started
- **/admin-web/**: The central "mission control" for platform administrators. This React/Vite web application provides a secure interface for:
- **User Management:** Inviting new users (the very first client or operator) and managing roles/permissions across the entire ecosystem.
- **Platform Analytics:** Monitoring application usage, top pages, and user activity.
- **System Logs:** A log explorer for diagnosing issues and monitoring the platform's health.
This project uses a central `Makefile` to orchestrate all common tasks.
- **/frontend-web/**: The primary web application for core business operations, used by procurement managers, operators, and clients. This React/Vite application includes modules for:
- **Vendor Management:** Onboarding, compliance tracking, and performance scorecards.
- **Event & Order Management:** Creating and managing staffing orders.
- **Invoicing & Payroll:** Financial workflows for clients and staff.
- **Dashboards:** Role-specific dashboards for different user types.
1. **Install Dependencies:**
```bash
make install
```
*(This will install dependencies for the web frontend. Mobile dependency installation is handled within their respective directories.)*
- **/mobile-apps/**: This directory is planned for our future mobile applications. It is structured to contain two distinct apps:
- `client-app`: A dedicated application for clients to create orders, track events, and manage billing on the go.
- `staff-app`: An essential tool for workforce members to view schedules, clock in/out, manage their profiles, and track earnings.
2. **Run a Service:**
- To run the web frontend: `make dev`
- *(Additional commands for mobile and backend will be added as development progresses.)*
- **/docs/**: The single source of truth for all project documentation. This includes:
- **Vision & Roadmaps:** High-level strategy, product goals, and technical direction.
- **Architecture:** Detailed diagrams and explanations of the system architecture.
- **API Specifications:** Documentation for our GraphQL API.
- **Development Guides:** Conventions, setup instructions, and maintenance procedures.
3. **See All Commands:**
For a full list of available commands, run:
```bash
make help
```
- **/scripts/**: A collection of automation scripts to streamline development and operational tasks. These scripts are primarily executed via the `Makefile` and handle tasks like database patching, environment setup, and code generation.
## 🤝 Contributing
New to the KROW team? Start here to set up your environment and understand our development practices: **[CONTRIBUTING.md](./CONTRIBUTING.md)**
---
- **/secrets/**: A Git-ignored directory for storing sensitive credentials, API keys, and environment-specific configuration files. This ensures that no confidential information is ever committed to the repository.
## 📚 Documentation Overview
@@ -52,3 +47,35 @@ This section provides a quick guide to the most important documentation files in
- **[06-maintenance-guide.md](./docs/06-maintenance-guide.md)**: The operational manual for integrating updates from the Base44 visual builder.
- **[07-reference-base44-api-export.md](./docs/07-reference-base44-api-export.md)**: The raw API documentation exported from Base44, used as a reference.
- **[08-reference-base44-prompts.md](./docs/08-reference-base44-prompts.md)**: A collection of standardized prompts for interacting with the Base44 AI.
## 🤝 Contributing
New to the KROW team? Start here to set up your environment and understand our development practices: **[CONTRIBUTING.md](./CONTRIBUTING.md)**
## 🛠️ Tech Stack
- **Frontend:** React with Vite (JavaScript)
- **Styling:** Tailwind CSS
- **Backend:** Firebase (Firestore, Cloud Storage, Authentication, Data Connect)
- **Mobile:** Flutter (planned)
## 📦 Getting Started
1. **Clone the repository:**
```bash
git clone https://github.com/Oloodi/krow.git
cd krow
```
2. **Install dependencies for the main web app:**
```bash
cd frontend-web
npm install
```
3. **Run the development server:**
```bash
npm run dev
```
The main application will be available at `http://localhost:5173`. For other packages, refer to their respective `README.md` files.