0f9ca9eb15
This commit introduces a pre-push Git hook that prevents direct pushes to the `main` and `dev` branches. This enforces the use of pull requests for merging changes into these protected branches, promoting code review and maintaining branch stability. The changes include: - Adding a `install-git-hooks` target to the Makefile to symlink the pre-push script into the `.git/hooks/` directory. - Creating the `scripts/git-hooks/pre-push` script that checks the target branch and aborts the push if it matches a protected branch. - Updating the `CONTRIBUTING.md` file to instruct developers to install the Git hooks after setting up their development environment.
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.