mirror of
https://github.com/elisiariocouto/leggen.git
synced 2025-12-23 23:19:28 +00:00
95 lines
4.0 KiB
Markdown
95 lines
4.0 KiB
Markdown
# Agent Guidelines for Leggen
|
|
|
|
## Quick Setup for Development
|
|
|
|
### Prerequisites
|
|
- **uv** must be installed for Python dependency management (can be installed via `pip install uv`)
|
|
|
|
### Generate Mock Database
|
|
The leggen CLI provides a command to generate a mock database for testing:
|
|
|
|
```bash
|
|
# Generate sample database with default settings (3 accounts, 50 transactions each)
|
|
uv run leggen generate_sample_db --database /path/to/test.db --force
|
|
|
|
# Custom configuration
|
|
uv run leggen generate_sample_db --database ./test-data.db --accounts 5 --transactions 100 --force
|
|
```
|
|
|
|
The command outputs instructions for setting the required environment variable to use the generated database.
|
|
|
|
### Start the API Server
|
|
1. Install uv if not already installed: `pip install uv`
|
|
2. Set the database environment variable to point to your generated mock database:
|
|
```bash
|
|
export LEGGEN_DATABASE_PATH=/path/to/your/generated/database.db
|
|
```
|
|
3. Start the API server:
|
|
```bash
|
|
uv run leggend
|
|
```
|
|
- For development mode with auto-reload: `uv run leggend --reload`
|
|
- API will be available at `http://localhost:8000` with docs at `http://localhost:8000/docs`
|
|
|
|
### Start the Frontend
|
|
1. Navigate to the frontend directory: `cd frontend`
|
|
2. Install npm dependencies: `npm install`
|
|
3. Start the development server: `npm run dev`
|
|
- Frontend will be available at `http://localhost:3000`
|
|
- The frontend is configured to connect to the API at `http://localhost:8000/api/v1`
|
|
|
|
## Build/Lint/Test Commands
|
|
|
|
### Frontend (React/TypeScript)
|
|
- **Dev server**: `cd frontend && npm run dev`
|
|
- **Build**: `cd frontend && npm run build`
|
|
- **Lint**: `cd frontend && npm run lint`
|
|
|
|
### Backend (Python)
|
|
- **Lint**: `uv run ruff check .`
|
|
- **Format**: `uv run ruff format .`
|
|
- **Type check**: `uv run mypy leggen leggend --check-untyped-defs`
|
|
- **All checks**: `uv run pre-commit run --all-files`
|
|
- **Run all tests**: `uv run pytest`
|
|
- **Run single test**: `uv run pytest tests/unit/test_api_accounts.py::TestAccountsAPI::test_get_all_accounts_success -v`
|
|
- **Run tests by marker**: `uv run pytest -m "api"` or `uv run pytest -m "unit"`
|
|
|
|
## Code Style Guidelines
|
|
|
|
### Python
|
|
- **Imports**: Standard library → Third-party → Local (blank lines between groups)
|
|
- **Naming**: snake_case for variables/functions, PascalCase for classes
|
|
- **Types**: Use type hints for all function parameters and return values
|
|
- **Error handling**: Use specific exceptions, loguru for logging
|
|
- **Path handling**: Use `pathlib.Path` instead of `os.path`
|
|
- **CLI**: Use Click framework with proper option decorators
|
|
|
|
### TypeScript/React
|
|
- **Imports**: React hooks first, then third-party, then local components/types
|
|
- **Naming**: PascalCase for components, camelCase for variables/functions
|
|
- **Types**: Use `import type` for type-only imports, define interfaces/types
|
|
- **Styling**: Tailwind CSS with `clsx` utility for conditional classes
|
|
- **Icons**: lucide-react with consistent naming
|
|
- **Data fetching**: @tanstack/react-query with proper error handling
|
|
- **Components**: Functional components with hooks, proper TypeScript typing
|
|
|
|
### General
|
|
- **Formatting**: ruff for Python, ESLint for TypeScript
|
|
- **Commits**: Use conventional commits with optional scopes, run pre-commit hooks before pushing
|
|
- Format: `type(scope): Description starting with uppercase and ending with period.`
|
|
- Scopes: `cli`, `api`, `frontend` (optional)
|
|
- Types: `feat`, `fix`, `refactor` (avoid too many different types)
|
|
- Examples:
|
|
- `feat(frontend): Add support for S3 backups.`
|
|
- `fix(api): Resolve authentication timeout issues.`
|
|
- `refactor(cli): Improve error handling for missing config.`
|
|
- Avoid including specific numbers, counts, or data-dependent information that may become outdated
|
|
- **Security**: Never log sensitive data, use environment variables for secrets
|
|
|
|
## Contributing Guidelines
|
|
|
|
This repository follows conventional changelog practices. Refer to `CONTRIBUTING.md` for detailed contribution guidelines including:
|
|
- Commit message format and scoping
|
|
- Release process using `scripts/release.sh`
|
|
- Pre-commit hooks setup with `pre-commit install`
|