# XinAdmin 文档

> XinAdmin 企业级 PHP 全栈开发框架的中英文项目文档。

## Guide

- [Guide Overview](/en/guide/index.md): Navigate the XinAdmin documentation, including project concepts, environment setup, installation, source layout, and frontend or backend development.
- [Introduction](/en/guide/introduction.md): Explore XinAdmin's Laravel and React stack, role permissions, dynamic menus, system modules, AI assistants, and common enterprise use cases.
- [Installation](/en/guide/getting-started.md): Install XinAdmin with Composer and pnpm, initialize SQLite or MySQL, and start the Laravel and React development environments.
- [Directory Structure](/en/guide/directory-structure.md): Understand XinAdmin's monorepo layout, including Laravel application code, the React frontend, migrations, system models, and public assets.
- [Configuration](/en/guide/configuration.md): Configure XinAdmin application URLs, databases, cache, queues, mail, storage, Redis, and frontend environment variables.
- [Core Concepts](/en/guide/core-concepts.md): Understand relationships between XinAdmin users, departments, roles, access rules, dynamic menus, tokens, and dictionary data.
- [Development Workflow](/en/guide/development-workflow.md): Build a complete XinAdmin feature through database schema, models, validation, attribute APIs, React pages, and permission menus.
- [Testing and Code Quality](/en/guide/testing.md): Check XinAdmin with PHPUnit, in-memory SQLite, TypeScript, and Oxlint across backend features and frontend source quality.
- [FAQ](/en/guide/faq.md): Troubleshoot XinAdmin installation, migrations, frontend API connections, authentication, dynamic menus, permissions, and file uploads.

## Frontend

- [Frontend Overview](/en/frontend/index.md): Review XinAdmin's React, TypeScript, Zustand, and Ant Design frontend, including environment variables and the shared Axios request wrapper.
- [File-based Routing](/en/frontend/routing.md): Generate React Router routes from XinAdmin's pages directory and understand lazy loading, login, 404 routes, and dynamic menu integration.
- [Adding a Page](/en/frontend/new-page.md): Add a complete XinAdmin frontend business page with a component, domain types, API functions, dynamic menus, and role permissions.
- [Request Wrapper](/en/frontend/request.md): Use XinAdmin's Axios deduplication, Bearer authentication, language headers, business errors, and HTTP 401 handling.
- [State Management](/en/frontend/state-management.md): Use XinAdmin Zustand stores for users, global settings, and dictionaries, including persistence, initialization, and authentication synchronization.
- [XinTable](/en/frontend/xin-table.md): Configure XinTable CRUD lists with search, pagination, sorting, forms, toolbars, action permissions, and custom requests.
- [XinForm](/en/frontend/xin-form.md): Build standard, modal, and drawer forms with XinForm columns, grids, submitters, triggers, and imperative form methods.
- [Fields and Uploads](/en/frontend/form-fields.md): Configure XinAdmin field types, conditional visibility, dynamic disabled states, image uploads, icon selectors, and user selectors.
- [Authorization Component](/en/frontend/auth-button.md): Control XinAdmin action visibility with AuthButton permission keys while keeping backend endpoint authorization authoritative.
- [Dictionary Component](/en/frontend/dict-tag.md): Render dictionary values as text, tags, or badges with DictTag and create consistent options from the dictionary store.
- [Layout and Theme](/en/frontend/layout-theme.md): Configure XinAdmin side, top, mix, and columns layouts, color schemes, brand colors, dimensions, and regional colors.
- [Internationalization](/en/frontend/i18n.md): Maintain XinAdmin Chinese and English frontend resources, i18next language state, and the backend User-Language request header.
- [Environment and Builds](/en/frontend/environment.md): Manage XinAdmin VITE_BASE_URL, development and production environments, TypeScript checks, and Vite build or preview commands.

## Backend

- [Backend Overview](/en/backend/index.md): Review XinAdmin's Laravel backend layers, system controllers, Eloquent models, Sanctum authentication, validation, and database initialization.
- [Attribute Routes & Permissions](/en/backend/routing.md): Declare Laravel endpoint paths, HTTP methods, route parameters, and permission keys with XinAdmin PHP attributes and automatic controller scanning.
- [API Response Conventions](/en/backend/api-conventions.md): Follow XinAdmin's shared JSON response schema, including success, data, msg, showType, authentication headers, and frontend error handling.
- [Controllers and CRUD](/en/backend/controllers.md): Build XinAdmin admin endpoints and standard CRUD flows with BaseController, Eloquent models, and Laravel Form Requests.
- [List Queries](/en/backend/list-queries.md): Build XinAdmin list endpoints with BaseController filters, quick search, date ranges, sorting, and pagination parameters.
- [Models and Relationships](/en/backend/models.md): Define XinAdmin Eloquent models, mass assignment, casts, relationships, and reusable business query boundaries.
- [Validation](/en/backend/validation.md): Validate XinAdmin endpoint input, arrays, route IDs, and business rules with Laravel Form Requests and validate helpers.
- [Authentication](/en/backend/authentication.md): Understand XinAdmin authentication with Laravel Sanctum, SysAccessToken, SysUserModel, and Bearer tokens.
- [Authorization](/en/backend/authorization.md): Connect XinAdmin permission prefixes, method authorize values, role rules, and frontend buttons into server-side authorization.
- [Middleware](/en/backend/middleware.md): Use XinAdmin CORS, language, and login-record middleware with Laravel global registration and route execution order.
- [Services and Reuse](/en/backend/services.md): Divide XinAdmin responsibilities among controllers, services, traits, helpers, and models for reusable uploads, responses, and business logic.
- [Migrations and Seeders](/en/backend/database.md): Manage XinAdmin migrations, seeders, initial administrators, permission menus, site settings, and AI assistant records.
- [Cache, Queues, and Redis](/en/backend/cache-queue.md): Configure XinAdmin database cache and queues, Redis extensions, and local or production worker requirements.
- [Backend Testing](/en/backend/testing.md): Write PHPUnit unit and feature tests for XinAdmin controllers, models, and permission APIs using isolated in-memory databases.

## Modules

- [Module Overview](/en/modules/index.md): Browse XinAdmin module documentation for dashboards, administrators, organization, permissions, dictionaries, files, settings, and profiles.
- [Dashboard](/en/modules/dashboard.md): Explore XinAdmin analysis, monitoring, and workplace dashboards, plus ECharts visualizations and static monitoring assets.
- [Administrators](/en/modules/users.md): Manage XinAdmin administrators with list, create, update, role assignment, status, password reset, and access relationships.
- [Departments](/en/modules/departments.md): Maintain XinAdmin administrator organization with department trees, create, update, deletion rules, and department member queries.
- [Roles](/en/modules/roles.md): Implement XinAdmin RBAC with role lists, members, status, permission-tree queries, and role access-rule assignment.
- [Access Rules and Dynamic Menus](/en/modules/rules.md): Maintain XinAdmin access rules, dynamic menus, page paths, action permissions, icons, ordering, visibility, and external links.
- [Dictionaries](/en/modules/dictionaries.md): Maintain XinAdmin dictionary options, labels, values, and colors for reuse across frontend tables and forms.
- [File Management](/en/modules/files.md): Use XinAdmin file upload, download, grouping, editing, and deletion with storage services, public assets, and security controls.
- [Site Settings](/en/modules/settings.md): Maintain XinAdmin site titles, logos, and runtime options with setting groups, items, save operations, and cache refresh.
- [Login Records](/en/modules/login-records.md): Review XinAdmin administrator login records and recent personal sign-ins, including middleware capture and audit extension options.
- [Profile](/en/modules/profile.md): Maintain the current XinAdmin administrator profile, avatar, password, and recent login records through dedicated endpoints.
- [AI Assistants](/en/modules/ai-agents.md): Manage XinAdmin AI assistant settings, default assistant data, and Agent endpoints in relation to conversations and chat.
- [AI Conversations and Chat](/en/modules/ai-chat.md): Use XinAdmin AI conversations, chat, and context management with Ant Design X, streaming requests, and failure handling.

## API Reference

- [Using the API](/en/api/index.md): Use XinAdmin API base URLs, Bearer authentication, language headers, permission keys, and shared JSON responses.
- [Authentication and Current User](/en/api/auth.md): Call XinAdmin sign-in, logout, user information, dynamic menu, profile, password, avatar, and recent-login endpoints.
- [Administrator API](/en/api/users.md): Query and manage XinAdmin administrators with create, update, delete, password reset, and role or department option endpoints.
- [Department API](/en/api/departments.md): Call XinAdmin department tree, create, update, batch delete, and paginated department member endpoints.
- [Role API](/en/api/roles.md): Call XinAdmin role CRUD, member, status, permission-tree, and role access-rule assignment endpoints.
- [Access Rule API](/en/api/rules.md): Call XinAdmin menu rule tree, create, update, delete, parent options, visibility, and enabled-status endpoints.
- [Dictionary API](/en/api/dictionaries.md): Call XinAdmin dictionary and item list, create, update, delete, and public all-dictionary endpoints.
- [File API](/en/api/files.md): Call XinAdmin file upload, download, copy, move, rename, trash, restore, force-delete, and file-group endpoints.
- [Site Settings API](/en/api/settings.md): Call XinAdmin setting-group and item CRUD, bulk site-setting saves, and configuration-cache refresh endpoints.
- [AI API](/en/api/ai.md): Call XinAdmin AI assistant query and update, chat send, conversation list, message read, and conversation deletion endpoints.
- [Responses and Errors](/en/api/responses.md): Handle XinAdmin HTTP statuses, business success, data, msg, showType, validation errors, and streaming response differences.

## Deployment

- [Deployment Overview](/en/deployment/index.md): Plan XinAdmin Laravel and React production deployment, databases, web servers, queues, storage, security, and maintenance.
- [Production Deployment](/en/deployment/production.md): Deploy XinAdmin through dependency, environment, database, Laravel optimization, React asset, process, and rollback checks.
- [Nginx and Proxying](/en/deployment/nginx.md): Configure XinAdmin Laravel public roots, PHP-FPM, React static assets, browser-route fallback, and API reverse proxies.
- [Database Deployment](/en/deployment/database.md): Configure XinAdmin production MySQL or SQLite, migration backups, least-privilege accounts, and verified data recovery.
- [Queues and Redis](/en/deployment/queue-redis.md): Operate XinAdmin database or Redis queues, workers, caches, schedulers, monitoring, and automatic restarts in production.
- [Mail and Storage](/en/deployment/mail-storage.md): Configure XinAdmin production mail delivery, queued messages, storage disks, upload limits, private downloads, and backups.
- [Security Checklist](/en/deployment/security.md): Review XinAdmin default passwords, HTTPS, debug mode, keys, permissions, public routes, uploads, and sensitive logs before launch.
- [Updates and Maintenance](/en/deployment/maintenance.md): Maintain XinAdmin releases, database compatibility, cache refresh, worker restarts, backup recovery, and log monitoring.

## Reference

- [Reference Overview](/en/reference/index.md): Quickly reference XinAdmin environment variables, commands, permission names, response types, default data, versions, and terminology.
- [Environment Variables](/en/reference/environment-variables.md): Reference XinAdmin APP, DB, CACHE, QUEUE, REDIS, MAIL, FILESYSTEM, and frontend VITE environment variables.
- [Commands](/en/reference/commands.md): Reference XinAdmin Composer setup, Laravel server, migration, test, and pnpm frontend development or preview commands.
- [Permission Naming](/en/reference/permission-naming.md): Name XinAdmin permission keys by resource and action across controllers, database rules, roles, and frontend buttons.
- [Response Types](/en/reference/response-types.md): Reference XinAdmin ShowType success, warning, error, notification, and silent values with shared response fields.
- [Default Data](/en/reference/default-data.md): Review XinAdmin seeded administrators, sample users, roles, departments, access menus, site settings, and AI assistants.
- [Technology Versions](/en/reference/versions.md): Review current XinAdmin PHP, Laravel, React, Ant Design, Vite, TypeScript, Zustand, and testing dependency versions.
- [Glossary](/en/reference/glossary.md): Standardize XinAdmin documentation terms for users, roles, rules, menus, permissions, dictionaries, settings, tokens, and conversations.