From 0ea774a16949f82e1f2a5244712b2dc92b16498c Mon Sep 17 00:00:00 2001 From: Abizrh Date: Fri, 8 Aug 2025 09:21:58 +0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20docs=20(readme):=20clarify=20com?= =?UTF-8?q?ponent=20usage=20and=20workflow=20in=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0889a937..f58011d2 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ RSSA - Front End - `app.vue`: Main layout - `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/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. - `composables` : Contains reusable logic and utility functions (e.g. composables, hooks).. - `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. ### Build UI Components in `components/app` -- Create reusable UI and app-specific components. -- Keep components pure — avoid making HTTP requests directly within them. +- Create reusable UI and app specific components. +- Keep components pure, avoid making HTTP requests directly within them. - They receive data via props and emit events upward. ### Business Logic in `components/flows` - 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. ### Create Pages in `pages/` - 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.