edf3dc4042
feat: add issue template feat: add labels.yml with platform:admin label feat: add setup_admin_console.sh script and update Makefile This commit introduces several new features and files to the repository: - Adds a reference document for Base44 entity schemas to ensure data integrity during the migration to the new GCP/Firebase backend. - Adds an issue template to standardize issue reporting and ensure all necessary information is included. - Adds a new label to `labels.yml` for tasks specific to the Admin Console web app. - Adds a shell script to automate the setup of the Admin Console web application, including scaffolding, dependency installation, and configuration. Also updates the Makefile to include new targets for managing the Admin Console application. - Adds issues to create markdown file.
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.