`
+- Include `aria-label` on icon-only buttons
+- Use `lucide-react` for icons (already a dev dependency)
+
+**Don't:**
+- Hardcode colour hex values in component code
+- Use inline styles (except for truly dynamic values like calculated positions)
+- Use CSS modules or styled-components
+- Skip the `label` prop on form controls — all inputs must have visible labels
+- Nest interactive elements (button inside button, link inside button)
diff --git a/README.md b/README.md
index 7dbf7eb..c1320d7 100644
--- a/README.md
+++ b/README.md
@@ -1,73 +1,32 @@
-# React + TypeScript + Vite
+# ADS 3.0 Design System
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+A React component library implementing the ADS 3.0 (Adaptive Design System) design language. Built with React 19, TypeScript, Tailwind CSS v4, and Storybook 10.
-Currently, two official plugins are available:
+## Getting Started
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
-
-## React Compiler
-
-The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default defineConfig([
- globalIgnores(['dist']),
- {
- files: ['**/*.{ts,tsx}'],
- extends: [
- // Other configs...
-
- // Remove tseslint.configs.recommended and replace with this
- tseslint.configs.recommendedTypeChecked,
- // Alternatively, use this for stricter rules
- tseslint.configs.strictTypeChecked,
- // Optionally, add this for stylistic rules
- tseslint.configs.stylisticTypeChecked,
-
- // Other configs...
- ],
- languageOptions: {
- parserOptions: {
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
- tsconfigRootDir: import.meta.dirname,
- },
- // other options...
- },
- },
-])
+```bash
+npm install
+npm run storybook # Component development at localhost:6006
+npm run dev # Vite dev server
```
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
+## Architecture
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
+- **Tokens** — Design tokens in `src/tokens/tokens.css` as a Tailwind v4 `@theme` block
+- **Atoms** — Single-purpose elements (Button, Input, Badge, etc.)
+- **Molecules** — Small compositions (Alert, Dialog, Card, Accordion)
+- **Organisms** — Page-level regions (AppShell, TabBar)
-export default defineConfig([
- globalIgnores(['dist']),
- {
- files: ['**/*.{ts,tsx}'],
- extends: [
- // Other configs...
- // Enable lint rules for React
- reactX.configs['recommended-typescript'],
- // Enable lint rules for React DOM
- reactDom.configs.recommended,
- ],
- languageOptions: {
- parserOptions: {
- project: ['./tsconfig.node.json', './tsconfig.app.json'],
- tsconfigRootDir: import.meta.dirname,
- },
- // other options...
- },
- },
-])
-```
+## Usage as a Base
+
+This repo is designed to be forked for specific applications. Fork it, then build your application screens and domain logic on top of the shared component set.
+
+## Tech Stack
+
+| Tool | Purpose |
+|------|---------|
+| React 19 | UI framework |
+| TypeScript (strict) | Type safety |
+| Tailwind CSS v4 | Utility-first styling via CSS-first config |
+| Storybook 10 | Component development and documentation |
+| Vite | Build tooling |
diff --git a/index.html b/index.html
index b6f21a4..ef15f10 100644
--- a/index.html
+++ b/index.html
@@ -4,7 +4,7 @@
-
sdc-frontend
+
ADS 3.0 Design System
diff --git a/package.json b/package.json
index 17ae80a..e6a347f 100644
--- a/package.json
+++ b/package.json
@@ -1,5 +1,5 @@
{
- "name": "sdc-frontend",
+ "name": "ads3-design-system",
"private": true,
"version": "0.0.0",
"type": "module",
diff --git a/src/App.tsx b/src/App.tsx
index b9183fc..c7c36c3 100644
--- a/src/App.tsx
+++ b/src/App.tsx
@@ -2,11 +2,11 @@ function App() {
return (
- SDC Design System
+ ADS 3.0 Design System
- Component library for the Research Synthesiser.
+ React component library implementing the ADS 3.0 design language.
diff --git a/src/components/molecules/Accordion/Accordion.stories.tsx b/src/components/molecules/Accordion/Accordion.stories.tsx
index c44fb59..c8eb97b 100644
--- a/src/components/molecules/Accordion/Accordion.stories.tsx
+++ b/src/components/molecules/Accordion/Accordion.stories.tsx
@@ -39,8 +39,8 @@ export const Default: Story = {
What is this design system?
- A React component library built for the Research Synthesiser, following NSW Design System
- patterns with custom tokens and Tailwind CSS v4.
+ A React component library implementing the ADS 3.0 design language with custom tokens
+ and Tailwind CSS v4.