For AI agents: the complete documentation index is available at /en/llms.txt, the full documentation bundle is available at /en/llms-full.txt, and this page is available as Markdown at /en/guide/index.md.
  • English

      • Guide Overview

      Start here to understand XinAdmin's technical scope, installation process, and source organization.

      Getting started

      PageWhat it covers
      IntroductionTechnology stack, core capabilities, and use cases
      InstallationDatabase initialization and Laravel or Vite development servers
      Directory StructureBackend, frontend, database, and static asset locations
      ConfigurationLaravel, database, and Vite environment variables
      Core ConceptsUsers, roles, menus, permissions, and dictionaries

      Development and troubleshooting

      • Development Workflow: From migrations to React pages and role permissions.
      • Frontend: Routes, requests, stores, tables, forms, and themes.
      • Backend: Controllers, attribute routes, authentication, models, and tests.
      • Modules: Usage and source entry points for built-in features.
      • API Reference: Real endpoints and permissions grouped by resource.
      • Deployment: Production, Nginx, queues, storage, and security.
      • Reference: Commands, versions, permission names, and default data.
      • Testing and FAQ.
      Tip

      This documentation follows the actual source code in xin-admin-v3. Historical version numbers in the project README are not used as the version reference for this site.