mirror of
https://github.com/elisiariocouto/leggen.git
synced 2025-12-11 16:12:22 +00:00
docs: Add instructions for shadcn/ui.
This commit is contained in:
13
AGENTS.md
13
AGENTS.md
@@ -81,6 +81,7 @@ The command outputs instructions for setting the required environment variable t
|
|||||||
- **Naming**: PascalCase for components, camelCase for variables/functions
|
- **Naming**: PascalCase for components, camelCase for variables/functions
|
||||||
- **Types**: Use `import type` for type-only imports, define interfaces/types
|
- **Types**: Use `import type` for type-only imports, define interfaces/types
|
||||||
- **Styling**: Tailwind CSS with `clsx` utility for conditional classes
|
- **Styling**: Tailwind CSS with `clsx` utility for conditional classes
|
||||||
|
- **UI Components**: shadcn/ui components for consistent design system
|
||||||
- **Icons**: lucide-react with consistent naming
|
- **Icons**: lucide-react with consistent naming
|
||||||
- **Data fetching**: @tanstack/react-query with proper error handling
|
- **Data fetching**: @tanstack/react-query with proper error handling
|
||||||
- **Components**: Functional components with hooks, proper TypeScript typing
|
- **Components**: Functional components with hooks, proper TypeScript typing
|
||||||
@@ -94,7 +95,7 @@ The command outputs instructions for setting the required environment variable t
|
|||||||
- **Routes**: `frontend/src/routes/` - TanStack Router file-based routing
|
- **Routes**: `frontend/src/routes/` - TanStack Router file-based routing
|
||||||
|
|
||||||
### Key Components Location
|
### Key Components Location
|
||||||
- **UI Components**: `frontend/src/components/ui/` - Reusable UI primitives
|
- **UI Components**: `frontend/src/components/ui/` - shadcn/ui components and reusable UI primitives
|
||||||
- **Feature Components**: `frontend/src/components/` - Main app components
|
- **Feature Components**: `frontend/src/components/` - Main app components
|
||||||
- **Pages**: `frontend/src/routes/` - Route components (index.tsx, transactions.tsx, etc.)
|
- **Pages**: `frontend/src/routes/` - Route components (index.tsx, transactions.tsx, etc.)
|
||||||
- **Hooks**: `frontend/src/hooks/` - Custom React hooks
|
- **Hooks**: `frontend/src/hooks/` - Custom React hooks
|
||||||
@@ -121,6 +122,16 @@ The command outputs instructions for setting the required environment variable t
|
|||||||
- Avoid including specific numbers, counts, or data-dependent information that may become outdated
|
- Avoid including specific numbers, counts, or data-dependent information that may become outdated
|
||||||
- **Security**: Never log sensitive data, use environment variables for secrets
|
- **Security**: Never log sensitive data, use environment variables for secrets
|
||||||
|
|
||||||
|
## AI Development Support
|
||||||
|
|
||||||
|
### shadcn/ui Integration
|
||||||
|
This project uses shadcn/ui for consistent UI components. The MCP server is configured for AI agents to:
|
||||||
|
- Search and browse available shadcn/ui components
|
||||||
|
- View component implementation details and examples
|
||||||
|
- Generate proper installation commands for new components
|
||||||
|
|
||||||
|
Use the shadcn MCP tools when working with UI components to ensure consistency with the existing design system.
|
||||||
|
|
||||||
## Contributing Guidelines
|
## Contributing Guidelines
|
||||||
|
|
||||||
This repository follows conventional changelog practices. Refer to `CONTRIBUTING.md` for detailed contribution guidelines including:
|
This repository follows conventional changelog practices. Refer to `CONTRIBUTING.md` for detailed contribution guidelines including:
|
||||||
|
|||||||
@@ -1,9 +1,19 @@
|
|||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
Install Poetry and run `poetry install` to install dependencies. Then run `poetry shell` to activate the virtual environment.
|
This project uses **uv** for Python dependency management and **shadcn/ui** for frontend components.
|
||||||
|
|
||||||
|
## Setup
|
||||||
|
Install uv and run `uv sync` to install dependencies.
|
||||||
|
|
||||||
Run `pre-commit install` to install the pre-commit hooks.
|
Run `pre-commit install` to install the pre-commit hooks.
|
||||||
|
|
||||||
|
## Frontend Development
|
||||||
|
The frontend uses shadcn/ui components for consistent design. When adding new UI components:
|
||||||
|
- Check if a shadcn/ui component exists for your use case
|
||||||
|
- Follow the existing component patterns in `frontend/src/components/ui/`
|
||||||
|
- Use Tailwind CSS classes for styling
|
||||||
|
- Ensure components are accessible and follow the design system
|
||||||
|
|
||||||
## Commit messages
|
## Commit messages
|
||||||
|
|
||||||
type(scope/[subscope]): Title starting with uppercase and sentence ending with period.
|
type(scope/[subscope]): Title starting with uppercase and sentence ending with period.
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ Having your bank data accessible through both CLI and REST API gives you the pow
|
|||||||
- [React](https://reactjs.org/): Modern web interface with TypeScript
|
- [React](https://reactjs.org/): Modern web interface with TypeScript
|
||||||
- [Vite](https://vitejs.dev/): Fast build tool and development server
|
- [Vite](https://vitejs.dev/): Fast build tool and development server
|
||||||
- [Tailwind CSS](https://tailwindcss.com/): Utility-first CSS framework
|
- [Tailwind CSS](https://tailwindcss.com/): Utility-first CSS framework
|
||||||
|
- [shadcn/ui](https://ui.shadcn.com/): Modern component system built on Radix UI
|
||||||
- [TanStack Query](https://tanstack.com/query): Powerful data synchronization for React
|
- [TanStack Query](https://tanstack.com/query): Powerful data synchronization for React
|
||||||
|
|
||||||
## ✨ Features
|
## ✨ Features
|
||||||
|
|||||||
Reference in New Issue
Block a user