feat: Initialize monorepo structure and comprehensive documentation
This commit establishes the new monorepo architecture for the KROW Workforce platform. Key changes include: - Reorganized project into `frontend-web`, `mobile-apps`, `firebase`, `scripts`, and `secrets` directories. - Updated `Makefile` to support the new monorepo layout and automate Base44 export integration. - Fixed `scripts/prepare-export.js` for ES module compatibility and global component import resolution. - Created and updated `CONTRIBUTING.md` for developer onboarding. - Restructured, renamed, and translated all `docs/` files for clarity and consistency. - Implemented an interactive internal launchpad with diagram viewing capabilities. - Configured base Firebase project files (`firebase.json`, security rules). - Updated `README.md` to reflect the new project structure and documentation overview.
This commit is contained in:
55
docs/08-reference-base44-prompts.md
Normal file
55
docs/08-reference-base44-prompts.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Prompts for the Base44 AI
|
||||
|
||||
This file contains standardized prompts for use with the Base44 platform's artificial intelligence. The goal is to obtain precise and well-structured information about the "KROW Workforce" project's API and data schemas to facilitate the development of integrations and, if necessary, future migration.
|
||||
|
||||
## 1. Main Prompt: Request for Complete Documentation (Discreet and Iterative Version)
|
||||
|
||||
*Use this prompt after each new frontend export from Base44. It is phrased to avoid revealing the intention to migrate by requesting an update to an existing document.*
|
||||
|
||||
---
|
||||
|
||||
```text
|
||||
Hello!
|
||||
|
||||
I am the lead developer for the "KROW Workforce" project. We are looking to deeply integrate the Base44 platform into our wider ecosystem by building several custom tools and automations.
|
||||
|
||||
Previously, you generated an `API_documentation.md` file that was incredibly helpful for our team. To ensure our new integration projects are built using the most current project state, could you please refresh and exhaustively update this `API_documentation.md` file?
|
||||
|
||||
Please conduct a full review of our project and ensure the updated documentation includes the following for **all current entities** (Events, Staff, Vendors, Invoices, Users, Teams, etc.):
|
||||
|
||||
1. **Entity Data Schemas**: For each entity, a detailed breakdown of its fields in a table or JSON Schema format, including:
|
||||
* `Field Name`
|
||||
* `Data Type` (e.g., `string`, `number`, `timestamp`)
|
||||
* `Description` of the field's purpose.
|
||||
* `Validation Rules` (e.g., `required`, `unique`, `enum` values).
|
||||
|
||||
2. **SDK Operations**: A complete list of all available SDK methods for each entity (e.g., `.list()`, `.filter()`, `.create()`, `.update()`).
|
||||
|
||||
3. **Integrations API**: The full specification for all services under `base44.integrations.Core` (`SendEmail`, `InvokeLLM`, etc.), including their input parameters and output structure.
|
||||
|
||||
After you have updated the file, please output the **entire, updated content** of `API_documentation.md` in your response. This will serve as the single source of truth for our development team.
|
||||
|
||||
**IMPORTANT: Please ensure you output the ENTIRE, updated content of `API_documentation.md` directly in your response, not just a summary.**
|
||||
|
||||
Thank you!
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. Secondary Prompt: Request for a Specific Entity Schema
|
||||
|
||||
*Use this prompt if you need to quickly verify the structure of a single entity without requesting the full documentation.*
|
||||
|
||||
---
|
||||
|
||||
```text
|
||||
Hello!
|
||||
|
||||
For the "KROW Workforce" project, could you please provide the detailed data schema for the **[ENTITY_NAME]** entity?
|
||||
|
||||
Please format the response as a JSON Schema or a Markdown table, including the field names, data types, a description of each field, and any validation rules (like `required` fields or `enum` values).
|
||||
|
||||
For example, for an entity named `Event`.
|
||||
```
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user