9bdb250714
This commit introduces Firebase configuration files (.firebaserc, firebase.json) and updates the Makefile to include deployment commands for different environments (dev, staging). The .firebaserc file defines Firebase projects for development and staging, along with hosting targets. The firebase.json file configures hosting settings, including rewrites and ignores. It defines hosting targets for the main app in dev and staging, and a separate target for an internal launchpad. The Makefile is updated to include: - GCP project IDs for dev and staging. - Environment detection (ENV variable). - Conditional variables based on the environment (GCP_PROJECT_ID, FIREBASE_ALIAS, HOSTING_TARGET). - Deployment commands for the launchpad and the main app. - The build command now passes the environment variable to the frontend build process. The internal launchpad is added to firebase/internal-launchpad/index.html to provide quick access to application URLs and Firebase/GCP consoles for different environments. A patch script is added to inject the environment label into the Dashboard page. The index.html title is changed to KROW. These changes enable streamlined deployment and environment management for the KROW application.
KROW Workforce Platform
This monorepo contains the complete source code for the KROW Workforce platform, including the web frontend, mobile applications, and backend services.
🚀 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).
▶️ Getting Started
This project uses a central Makefile to orchestrate all common tasks.
-
Install Dependencies:
make install(This will install dependencies for the web frontend. Mobile dependency installation is handled within their respective directories.)
-
Run a Service:
- To run the web frontend:
make dev - (Additional commands for mobile and backend will be added as development progresses.)
- To run the web frontend:
-
See All Commands: For a full list of available commands, run:
make help
🤝 Contributing
New to the KROW team? Start here to set up your environment and understand our development practices: CONTRIBUTING.md
📚 Documentation Overview
This section provides a quick guide to the most important documentation files in this monorepo, ordered by logical reading flow:
- 00-vision.md: The "Why" behind the KROW platform, outlining our core objectives and guiding principles.
- 01-product-functional-roadmap.md: The "What" we are building, from a user-facing features perspective.
- 02-architecture-overview.md: Visual diagrams explaining the technical architecture of our web and mobile applications.
- 03-backend-api-specification.md: The detailed technical specification for our custom backend API.
- 04-strategy-technical-roadmap.md: Our strategic plan for building the platform, outlining phases and milestones.
- 05-project-plan.md: A detailed breakdown of tasks by milestone, ready for GitHub Issues.
- 06-maintenance-guide.md: The operational manual for integrating updates from the Base44 visual builder.
- 07-reference-base44-api-export.md: The raw API documentation exported from Base44, used as a reference.
- 08-reference-base44-prompts.md: A collection of standardized prompts for interacting with the Base44 AI.