Rebrand to ADS 3.0 Design System and add DESIGN.md component reference

Convert from Research Synthesiser-specific project to general-purpose ADS 3.0
design system intended to be forked for downstream applications. Add DESIGN.md
following Google Labs spec as machine-readable reference for AI coding agents.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-05-22 09:59:02 +10:00
parent 722475215d
commit f4fd1fc04b
6 changed files with 617 additions and 72 deletions

View File

@@ -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 |