๐ ๏ธ Contributing to the UI Repo
Thanks for your interest in contributing! This UI uses Next.js with ShadCN UI. The theme provider is already set up.
๐งฑ Project Structure
.
โโโ app/ # Next.js app directory (App Router)
โโโ components/ # Reusable UI components (e.g., Button, Input)
โโโ styles/ # Global styles and Tailwind config
โโโ lib/ # Utility functions or hooks
โโโ theme.config.ts # ShadCN theme setup
โโโ ...
๐ Getting Started
git clone https://github.com/your-org/ui-repo.git
cd ui-repo
pnpm install
pnpm dev๐ Theming (ShadCN)
We re using the ThemeProvider from ShadCN, configured in app/layout.tsx or providers.tsx.
- Dark mode and system theme are supported.
- No need to re-setup ShadCN. Use components directly from
@/components/ui/.
๐งฉ Adding Components
npx shadcn-ui@latest add dialog๐งช Testing & Storybook
pnpm test
pnpm storybook*If your project includes these tools
๐งผ Formatting & Linting
pnpm lint
pnpm formatโ Pull Request Checklist
- Your component matches the design system (attach a screenshot if needed).
- Responsive and accessible (keyboard + screen reader friendly).
- Dark mode tested.
- Use only
@/components/uior@/libimports. - Run linting and formatting before pushing.
๐ Every contribution helps. Thank you!