mirror of
https://github.com/elisiariocouto/leggen.git
synced 2025-12-26 00:19:35 +00:00
docs: Add instructions for shadcn/ui.
This commit is contained in:
@@ -1,9 +1,19 @@
|
||||
# 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.
|
||||
|
||||
## 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
|
||||
|
||||
type(scope/[subscope]): Title starting with uppercase and sentence ending with period.
|
||||
|
||||
Reference in New Issue
Block a user