📖 docs (readme): add nuxt minimal starter documentation

2025-08-07 14:46:27 +07:00
parent 645383e5cb
commit 1f72497ab4
2 changed files with 93 additions and 68 deletions
@@ -0,0 +1,75 @@
+# Nuxt Minimal Starter
+
+Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+
+## Setup
+
+Make sure to install dependencies:
+
+```bash
+# npm
+npm install
+
+# pnpm
+pnpm install
+
+# yarn
+yarn install
+
+# bun
+bun install
+```
+
+## Development Server
+
+Start the development server on `http://localhost:3000`:
+
+```bash
+# npm
+npm run dev
+
+# pnpm
+pnpm dev
+
+# yarn
+yarn dev
+
+# bun
+bun run dev
+```
+
+## Production
+
+Build the application for production:
+
+```bash
+# npm
+npm run build
+
+# pnpm
+pnpm build
+
+# yarn
+yarn build
+
+# bun
+bun run build
+```
+
+Locally preview production build:
+
+```bash
+# npm
+npm run preview
+
+# pnpm
+pnpm preview
+
+# yarn
+yarn preview
+
+# bun
+bun run preview
+```
+
+Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
@@ -1,75 +1,25 @@
-# Nuxt Minimal Starter
+# SIMRS - FE
+RSSA - Front End

-Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
+## Configuration
+- `nuxt.config.ts`<br />Nuxt configuration file
+- `.env`<br />Some environment variables

-## Setup
+## Directory Structure for `./app`
+- `app.vue`<br />Main layout
+- `components` : Contains all the components that are used in the app.
+- `components/flows` : related to business flows.
+- `components/app` : components that are used for common purpose.
+- `components/pub` : components that are used for common purpose.
+- `composables` : Contains all the composables/scripts that are used in the app.
+- `layouts` : to extract common UI patterns into reusable layouts accross the app

-Make sure to install dependencies:

-```bash
-# npm
-npm install
+## Directory Structure for `./app/pages` 
+- `./app/pages/auth` : pages for auth.
+- `./app/pages/(features)` : grouping features related to business flows.

-# pnpm
-pnpm install

-# yarn
-yarn install

-# bun
-bun install
-```
-
-## Development Server
-
-Start the development server on `http://localhost:3000`:
-
-```bash
-# npm
-npm run dev
-
-# pnpm
-pnpm dev
-
-# yarn
-yarn dev
-
-# bun
-bun run dev
-```
-
-## Production
-
-Build the application for production:
-
-```bash
-# npm
-npm run build
-
-# pnpm
-pnpm build
-
-# yarn
-yarn build
-
-# bun
-bun run build
-```
-
-Locally preview production build:
-
-```bash
-# npm
-npm run preview
-
-# pnpm
-pnpm preview
-
-# yarn
-yarn preview
-
-# bun
-bun run preview
-```
-
-Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
+## Workflows
+The basic workflow has the following steps: