- Backend: FastAPI app with all models, services, schemas, routes - Admin Panel: Next.js dashboard with all modules (CRM, POS, repairs, warranties, billing, notifications, etc.) - Ecommerce: storefront (submodule) + product catalog - AI Agents: .agents/ skill library for Antigravity IDE - Docs: architecture, billing, notification gateway markdown - Submodules: Backend/OpenWA, Ecommerce/File 2/storefront
82 lines
4.7 KiB
Markdown
82 lines
4.7 KiB
Markdown
# iFixKart Platform: Workflow Directory Analysis & Integration Guide
|
|
|
|
This report analyzes the contents of the `/mnt/fam/SERVER/IfixKartEcommerce/workflows` directory and outlines how they can be leveraged to enforce standardized coding practices, automate developer tasks, and configure custom agent capabilities.
|
|
|
|
---
|
|
|
|
## 1. Directory Structure & Inventory
|
|
|
|
The `workflows/` directory contains structured Markdown files that define **Standard Operating Procedures (SOPs)** for typical development, testing, and operations tasks.
|
|
|
|
```
|
|
workflows/
|
|
└── sharable/
|
|
├── backend/
|
|
│ ├── add-tests.md # Procedures for writing unit tests & coverage checking
|
|
│ ├── code-review.md # Standards for reviewing backend PRs & code logic
|
|
│ └── fix-bug.md # Steps for bug isolation, fixing, and regression testing
|
|
│
|
|
├── frontend/
|
|
│ ├── add-utility-function.md # Guidelines for reusable frontend helper functions
|
|
│ ├── create-component.md # Standard React component layout (JSDoc, BEM, prop destructuring)
|
|
│ └── test-feature.md # Manual & automated browser testing checklist
|
|
│
|
|
├── generic/
|
|
│ ├── add-docs.md # JSDoc, error logging patterns, and code comment styling
|
|
│ ├── review.md # Standardized pull request reviews
|
|
│ ├── review-my-pr.md # Advanced self-review checklist for agents
|
|
│ ├── security-review.md # Security auditing checklists
|
|
│ └── update-graphify.md # Synchronization workflows for internal tools
|
|
│
|
|
└── standard/
|
|
├── commit.md # Git commit message formats (Conventional Commits)
|
|
├── update-agents.md # Agent configuration syncing across IDE setups
|
|
└── update-clickup-ticket.md# Integration guidelines for ClickUp task tracking
|
|
```
|
|
|
|
---
|
|
|
|
## 2. Key Codebase Standards Defined in the Workflows
|
|
|
|
These workflows are not generic checklists; they enforce specific technical constraints for the iFixKart workspace:
|
|
* **React Component Layout (`create-component.md`)**: Reusable UI elements must be placed in `src/components/ComponentName/` with barrel exports (`index.ts`). Hex colors are banned; all color keys must refer to design token variables (e.g. `colors.scss`).
|
|
* **Documentation & Error Logging (`add-docs.md`)**: Explicitly defines import ordering (React $\rightarrow$ AntD/Shadcn $\rightarrow$ local components $\rightarrow$ utils $\rightarrow$ styles) and dictates the exact service error logging format: `console.error("[functionName] message:", error);`.
|
|
* **Git Workflows (`commit.md`)**: Enforces the Conventional Commits format (e.g. `feat(auth): add JWT token refresh mechanism`) and details when branch syncs and PR runs must happen.
|
|
|
|
---
|
|
|
|
## 3. How We Can Use These Workflows
|
|
|
|
We can utilize these files in three distinct ways within this workspace:
|
|
|
|
### Method A: Direct Workflow Execution
|
|
You can ask me to execute any workflow file directly. For example:
|
|
> *"Run the `create-component` workflow for a new alert card."*
|
|
|
|
When you do this, I will:
|
|
1. Load the corresponding file (e.g., `workflows/sharable/frontend/create-component.md`).
|
|
2. Follow the steps sequentially (verify options, check location, create barrel exports).
|
|
3. Confirm each checkbox in the **Checklist** section is fully satisfied before reporting completion.
|
|
|
|
---
|
|
|
|
### Method B: Workspace Customization (Auto-Discovery Rules)
|
|
You can configure me to automatically load and enforce these rules on every task.
|
|
By placing these files (or modifications of them) inside the workspace customization root, they become active parameters:
|
|
|
|
1. **Workspace Rules**: Copy the contents of the standards files (like `commit.md` or `add-docs.md`) and append them to `.agents/AGENTS.md` in the root of the workspace. This forces me to follow those guidelines for *every* code change.
|
|
2. **Workspace Skills**: Save the workflow files under `.agents/skills/<skill_name>/SKILL.md` with a YAML frontmatter:
|
|
```yaml
|
|
---
|
|
name: Create Component
|
|
description: Triggers when creating a reusable frontend component
|
|
---
|
|
```
|
|
Whenever you tell me *"create a new component..."*, the system automatically discovers and loads that skill, ensuring complete compliance with the ReloPortal standard.
|
|
|
|
---
|
|
|
|
### Method C: CI/CD and Code Quality Automation
|
|
These files can be integrated into your CI/CD pipelines (e.g. GitHub Actions) or pre-commit hooks:
|
|
* **Pre-commit Linter**: Enforce Git commit formats (`commit.md`) before commits are finalized.
|
|
* **PR Verification**: Use automated checks to run linting, tests (`add-tests.md`), and validation scripts on open Pull Requests.
|