mirror of https://github.com/langgenius/dify.git
75 lines
2.4 KiB
Markdown
75 lines
2.4 KiB
Markdown
# AGENTS.md
|
|
|
|
## Project Overview
|
|
|
|
Dify is an open-source platform for developing LLM applications with an intuitive interface combining agentic AI workflows, RAG pipelines, agent capabilities, and model management.
|
|
|
|
The codebase is split into:
|
|
|
|
- **Backend API** (`/api`): Python Flask application organized with Domain-Driven Design
|
|
- **Frontend Web** (`/web`): Next.js 15 application using TypeScript and React 19
|
|
- **Docker deployment** (`/docker`): Containerized deployment configurations
|
|
|
|
## Backend Workflow
|
|
|
|
- Read `api/AGENTS.md` for details
|
|
- Run backend CLI commands through `uv run --project api <command>`.
|
|
- Integration tests are CI-only and are not expected to run in the local environment.
|
|
|
|
## Frontend Workflow
|
|
|
|
```bash
|
|
cd web
|
|
pnpm lint:fix
|
|
pnpm type-check:tsgo
|
|
pnpm test
|
|
```
|
|
|
|
### Frontend Linting
|
|
|
|
ESLint is used for frontend code quality. Available commands:
|
|
|
|
```bash
|
|
# Lint all files (report only)
|
|
pnpm lint
|
|
|
|
# Lint and auto-fix issues
|
|
pnpm lint:fix
|
|
|
|
# Lint specific files or directories
|
|
pnpm lint:fix app/components/base/button/
|
|
pnpm lint:fix app/components/base/button/index.tsx
|
|
|
|
# Lint quietly (errors only, no warnings)
|
|
pnpm lint:quiet
|
|
|
|
# Check code complexity
|
|
pnpm lint:complexity
|
|
```
|
|
|
|
**Important**: Always run `pnpm lint:fix` before committing. The pre-commit hook runs `lint-staged` which only lints staged files.
|
|
|
|
## Testing & Quality Practices
|
|
|
|
- Follow TDD: red → green → refactor.
|
|
- Use `pytest` for backend tests with Arrange-Act-Assert structure.
|
|
- Enforce strong typing; avoid `Any` and prefer explicit type annotations.
|
|
- Write self-documenting code; only add comments that explain intent.
|
|
|
|
## Language Style
|
|
|
|
- **Python**: Keep type hints on functions and attributes, and implement relevant special methods (e.g., `__repr__`, `__str__`).
|
|
- **TypeScript**: Use the strict config, rely on ESLint (`pnpm lint:fix` preferred) plus `pnpm type-check:tsgo`, and avoid `any` types.
|
|
|
|
## General Practices
|
|
|
|
- Prefer editing existing files; add new documentation only when requested.
|
|
- Inject dependencies through constructors and preserve clean architecture boundaries.
|
|
- Handle errors with domain-specific exceptions at the correct layer.
|
|
|
|
## Project Conventions
|
|
|
|
- Backend architecture adheres to DDD and Clean Architecture principles.
|
|
- Async work runs through Celery with Redis as the broker.
|
|
- Frontend user-facing strings must use `web/i18n/en-US/`; avoid hardcoded text.
|