munawwirul_jamal/simrsx-fe
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📖 docs (readme): clarify component usage and workflow in readme

Browse Source
This commit is contained in:
Abizrh
2025-08-08 09:21:58 +07:00
parent 856ccf4537
commit 0ea774a169
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -5
View File
@@ -13,7 +13,7 @@ RSSA - Front End
- `app.vue`: Main layout - `app.vue`: Main layout
- `components` : Contains all reusable UI components. - `components` : Contains all reusable UI components.
- `components/flows` : Entry point for business logic and workflows. Pages or routes call these flow components to handle API requests and process application logic - `components/flows` : Entry point for business logic and workflows. Pages or routes call these flow components to handle API requests and process application logic
- `components/app` : View-layer components that manage and present data. These are used within flows/ to render or handle specific parts of the UI, and return results back to the flow - `components/app` : View-layer components that manage and present data. These are used within `flows/` to render or handle specific parts of the UI, and return results back to the flow
- `components/pub` : Public/shared components used across different parts of the app. - `components/pub` : Public/shared components used across different parts of the app.
- `composables` : Contains reusable logic and utility functions (e.g. composables, hooks).. - `composables` : Contains reusable logic and utility functions (e.g. composables, hooks)..
- `layouts` : Reusable UI layout patterns used across pages. - `layouts` : Reusable UI layout patterns used across pages.
@@ -33,15 +33,15 @@ The basic development workflow follows these steps:
- These should represent the structure of the data used across your app. - These should represent the structure of the data used across your app.
### Build UI Components in `components/app` ### Build UI Components in `components/app`
- Create reusable UI and app-specific components. - Create reusable UI and app specific components.
- Keep components pure — avoid making HTTP requests directly within them. - Keep components pure, avoid making HTTP requests directly within them.
- They receive data via props and emit events upward. - They receive data via props and emit events upward.
### Business Logic in `components/flows` ### Business Logic in `components/flows`
- This layer connects the UI with the logic (API calls, validations, navigation). - This layer connects the UI with the logic (API calls, validations, navigation).
- It composes components from components/app/, components/pub/, and other flows. - It composes components from `components/app/`, `components/pub/`, and other flows.
- Also responsible for managing state, side effects, and interactions. - Also responsible for managing state, side effects, and interactions.
### Create Pages in `pages/` ### Create Pages in `pages/`
- Pages load the appropriate flow from `components/flows/`. - Pages load the appropriate flow from `components/flows/`.
- They do not contain UI or logic directly—just route-level layout or guards. - They do not contain UI or logic directly, just route level layout or guards.