From ea2076d0976228166d6c6476ff0e09497f2cc8ff Mon Sep 17 00:00:00 2001 From: Abizrh Date: Sun, 7 Sep 2025 22:59:57 +0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=96=20docs=20(readme):=20update=20comp?= =?UTF-8?q?onent=20directory=20structure=20and=20descriptions?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 694ddf34..40601187 100644 --- a/README.md +++ b/README.md @@ -20,16 +20,20 @@ RSSA - Front End - `app.vue`: Main layout - `components` : Contains all reusable UI components. -- `components/flow` : 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 `flow/` to render or handle specific parts of the UI, and return results back to the flow +- `components/content` : Entry point for business logic and workflows. Pages or routes call these content components to handle API requests and process application logic +- `components/app` : View-layer components that manage and present data. These are used within `content/` to render or handle specific parts of the UI, and return results back to the content - `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. +- `models` : Contains data definitions or interfaces. +- `schemas` : Contains JSON schemas used for validation. +- `services` : Contains reusable API calls and business logic. + ## Directory Structure for `app/pages` - `pages/auth` : Authentication related pages. -- `pages/(features)` : Grouped feature modules that reflect specific business flow or domains. +- `pages/(features)` : Grouped feature modules that reflect specific business content or domains. ## Directory Structure for `server/` @@ -50,16 +54,16 @@ The basic development workflow follows these steps: - Keep components pure, avoid making HTTP requests directly within them. - They receive data via props and emit events upward. -### Business Logic in `components/flow` +### Business Logic in `components/content` - This layer connects the UI with the logic (API calls, validations, navigation). -- It composes components from `components/app/`, `components/pub/`, and other flow. +- It composes components from `components/app/`, `components/pub/`, and other content. - Also responsible for managing state, side effects, and interactions. ### Create Pages in `pages/` - Define permissions and guards for each page. -- Pages load the appropriate flow from `components/flow/`. +- Pages load the appropriate content from `components/content/`. - They do not contain UI or logic directly, just route level layout or guards. ## Code Conventions