first commit
This commit is contained in:
38
README.md
Normal file
38
README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# brus-ui
|
||||
|
||||
Vue 3 UI foundation built with `Vite`, `TypeScript`, `Tailwind CSS v4`, and `shadcn-vue`.
|
||||
|
||||
## Stack
|
||||
|
||||
- `Vue 3`
|
||||
- `TypeScript`
|
||||
- `Vite`
|
||||
- `Tailwind CSS v4`
|
||||
- `shadcn-vue`
|
||||
- `reka-ui`
|
||||
|
||||
## Getting Started
|
||||
|
||||
```bash
|
||||
nvm use
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
## Scripts
|
||||
|
||||
- `npm run dev` starts the local Vite server
|
||||
- `npm run typecheck` runs Vue + TypeScript checks
|
||||
- `npm run lint` runs ESLint
|
||||
- `npm run lint:fix` fixes auto-fixable lint issues
|
||||
- `npm run format` formats the repo with Prettier
|
||||
- `npm run format:check` verifies formatting without changing files
|
||||
- `npm run build` creates a production build
|
||||
- `npm run check` runs the main quality gate
|
||||
|
||||
## Project Notes
|
||||
|
||||
- Generated `shadcn-vue` primitives live under `src/components/ui`
|
||||
- App-specific composition lives outside the generated UI layer
|
||||
- Theme switching is handled by `src/composables/useTheme.ts`
|
||||
- Global design tokens live in `src/style.css`
|
||||
Reference in New Issue
Block a user