chore(husky): remove deprecated bootstrap lines; style: run prettier …

.github/workflows/cd-release.yml

@@ -21,8 +21,8 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: "20"
-          registry-url: "https://registry.npmjs.org"
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies
         run: npm ci

.github/workflows/ci-pr-validation.yml

@@ -2,9 +2,7 @@ name: CI - PR Validation
 
 on:
   pull_request:
-    branches: [develop]
-  push:
-    branches: [develop]
+    branches: [master]
 
 permissions:
   contents: read

.github/workflows/ci-release-check.yml

@@ -13,8 +13,6 @@ env:
 jobs:
   release-check:
     name: CI - Release Check
-    # Only run when PR is from develop -> master
-    if: github.head_ref == 'develop'
     runs-on: ubuntu-latest
 
     steps:

.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+on:
+  push:
+    branches: [develop, master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run typecheck
+      - run: npm run test:cov
+
+  build:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build
+
+  e2e:
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npx playwright install --with-deps
+      - run: npm run e2e

.github/workflows/release.yml

@@ -0,0 +1,33 @@
+name: Release
+on:
+  push:
+    branches: [master]
+
+permissions:
+  contents: write
+  pull-requests: write
+  id-token: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run typecheck
+      - run: npm test
+      - run: npm run build
+      - name: Changesets Release
+        uses: changesets/action@v1
+        with:
+          publish: npm publish --provenance
+          title: 'Release: version packages'
+          commit: 'chore: version packages'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.husky/_/.gitignore

@@ -1 +1 @@
-# *
+*

.husky/pre-commit

@@ -1,4 +1,4 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-npx lint-staged
+npm run format:write
+npm run lint
+npm run typecheck
+npm test

.husky/pre-push

@@ -1,5 +1,2 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 npm run typecheck
 npm test

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "all",
+  "printWidth": 100,
+  "tabWidth": 2,
+  "endOfLine": "lf"
+}

README.md

@@ -14,6 +14,20 @@ Template repository for building reusable React TypeScript **npm libraries**
 - Dependency-free styling (Tailwind-compatible by convention only)
 - `react` and `react-dom` as peerDependencies
 
+## Peer Dependencies & Requirements
+
+- React ecosystem:
+  - `react` and `react-dom` (host-provided)
+  - `react-router-dom` (required if you use `Breadcrumb` or any router-integrated components)
+  - `zod` (required if you use `ControlledZodDynamicForm`)
+  - `@ciscode/ui-translate-core` (optional i18n provider used by some components)
+
+Install in host app:
+
+```bash
+npm i react react-dom react-router-dom zod @ciscode/ui-translate-core
+```
+
 ## Package structure
 
 - `src/components` – reusable UI components
@@ -25,12 +39,127 @@ Anything not exported from `src/index.ts` is considered private.
 
 ## Scripts
 
-- `npm run build` – build to `dist/` (tsup)
-- `npm test` – run tests (vitest)
+## Scripts
+
+- `npm run dev` – start Vite dev server (for docs/examples)
+- `npm run preview` – preview Vite build
+- `npm run build` – build library to `dist/` (tsup: ESM + CJS + dts)
+- `npm test` – run unit/integration tests (Vitest)
+- `npm run test:cov` – run tests with coverage report
+- `npm run e2e` / `npm run e2e:headed` – run Playwright tests
 - `npm run typecheck` – TypeScript typecheck
+- `npm run type-check:watch` – TypeScript typecheck in watch mode
 - `npm run lint` – ESLint
 - `npm run format` / `npm run format:write` – Prettier
 - `npx changeset` – create a changeset
+  Anything not exported from `src/index.ts` is considered private.
+
+### Public API (summary)
+
+Root exports from `src/index.ts`:
+
+- Components: `Template`, `Breadcrumb`, `ControlledZodDynamicForm`, `TableDataCustom`
+- Hooks: `useLocalStorage`, `useColorMode`, `generatePageNumbers`
+- Types: `ColumnConfigTable`, `FieldConfigDynamicForm`, `ToolbarItem`, `SidebarItem`, `SidebarSection`, and layout types (`TemplateSidebarConfig`, `TemplateNavbarConfig`, `TemplateFooterConfig`, etc.)
+
+Internal-only components and utilities are intentionally not exported to avoid coupling (e.g. base-only table components). Use the wrapped components provided by the public API.
+
+### Router Integration
+
+Some components (e.g., `Breadcrumb`) rely on React Router. In host apps, wrap your app with `RouterProvider` from `react-router-dom` and ensure `Link` works:
+
+```tsx
+import { createBrowserRouter, RouterProvider } from 'react-router-dom';
+const router = createBrowserRouter([{ path: '/', element: <App /> }]);
+export function Root() {
+  return <RouterProvider router={router} />;
+}
+```
+
+### Usage Examples
+
+Hooks
+
+- `useLocalStorage`:
+  ```tsx
+  const [theme, setTheme] = useLocalStorage('color-theme', 'light');
+  ```
+- `useLogin`:
+  ```tsx
+  const { values, update, submit, loading, error } = useLogin({
+    login: async ({ username, password }) => ({ user: { name: username }, token: 't123' }),
+    schema: { parse: (v) => v },
+  });
+  ```
+
+Components
+
+- `Breadcrumb`:
+
+  ```tsx
+  <Breadcrumb pageName="Dashboard" />
+  ```
+
+- `TableDataCustom`:
+
+  ```tsx
+  import { TableDataCustom, type ColumnConfigTable } from '@ciscode/template-fe';
+
+  type Row = { id: number; name: string };
+  const columns: ColumnConfigTable<Row>[] = [
+    { key: 'id', title: 'ID' },
+    { key: 'name', title: 'Name' },
+  ];
+
+  <TableDataCustom<Row>
+    columns={columns}
+    data={[{ id: 1, name: 'Alice' }]}
+    pagination={{
+      currentPage: 1,
+      totalPages: 3,
+      totalItems: 1,
+      onPageChange: (p) => console.log(p),
+    }}
+  />;
+  ```
+
+- `ControlledZodDynamicForm`:
+
+  ```tsx
+  import { ControlledZodDynamicForm, type FieldConfigDynamicForm } from '@ciscode/template-fe';
+  import { z } from 'zod';
+
+  const schema = z.object({ name: z.string().min(1) });
+  const fields: FieldConfigDynamicForm[] = [{ key: 'name', label: 'Name', type: 'text' }];
+
+  <ControlledZodDynamicForm
+    fields={fields}
+    schema={schema}
+    values={{ name: '' }}
+    onChangeField={(field, val) => {
+      /* update your form state */
+    }}
+    onSubmit={(values) => console.log(values)}
+  />;
+  ```
+
+### Migration Guide (from older template)
+
+- Router: switch imports to `react-router-dom` (`Link`, `RouterProvider`).
+- Forms: `ControlledZodDynamicForm` expects controlled `values` and `onChangeField` for reliability.
+- Table: use `TableDataCustom` wrapper; base-only internals are private.
+- Exports: import only from the package root — all public APIs are re-exported via `src/index.ts`.
+
+### Testing & Coverage
+
+- Unit tests live under `tests/unit/` and run in `jsdom`.
+- Coverage uses `v8` provider; HTML report is written to `coverage/`.
+- We exclude demo/layout code from coverage to focus on exported library APIs.
+
+### RTL Support
+
+- Pagination icons respond to `document.dir` and mirror correctly for RTL.
+- Components use `ltr:` / `rtl:` Tailwind variants where layout matters.
 
 ## Release flow (summary)
 
@@ -40,5 +169,29 @@ Anything not exported from `src/index.ts` is considered private.
 - Promote `develop` → `master`
 - Tag `vX.Y.Z` to publish (npm OIDC)
 
+### Examples App
+
+- Run the local examples to preview components:
+
+```bash
+npm run dev:examples
+```
+
+- The examples import from the local source via an alias `@ciscode/template-fe`.
+
+To publish:
+
+- Ensure `npm run prepublishOnly` passes (format, lint, typecheck, tests, build).
+- Use Changesets to bump versions and generate changelog.
+- Publish with `npm publish --provenance`.
+
+### Publishing Checklist
+
+- `npm run prepublishOnly` succeeds
+- Unit coverage ≥ 80%
+- E2E smoke/examples pass (optional for host-only packages)
+- Changeset created and PR merged
+- `dist/` contains `index.js`, `index.cjs`, `index.d.ts`
+
 This repository is a **template**. Teams should clone it and focus only on
 library logic, not tooling or release mechanics.