How websideproject/nuxt-auto works
Nuxt Auto combines schema-generated REST APIs with a generated admin panel. A user interacts with the admin UI or an application using typed composables; requests reach generated resource routes, where shared context, authorization, tenant scoping, validation, and operation handlers govern database access. The API also documents bulk, aggregation, relation, export, and plugin capabilities, while the admin includes resource management and dashboards. The runtime pipeline and query composable are excerpted; several capability links below rely on README claims, so those edges are dashed where implementation wiring was not shown.
Main entry points: useAutoApiQuery.ts Typed API Queries · pipeline.ts Generated API Routes · createContextFromRegistry.ts Request Context · module.ts API Module
Components 20
Schema and Setup
- Drizzle Schema
packages/nuxt-auto-api/src/runtime/schema/index.ts - API Module
packages/nuxt-auto-api/src/module.ts - Admin Module
packages/nuxt-auto-admin/src/module.ts
API Runtime
- Typed API Queries
packages/nuxt-auto-api/src/runtime/composables/useAutoApiQuery.ts - Generated API Routes
packages/nuxt-auto-api/src/runtime/server/handlers/pipeline.ts - Resource Operations
packages/nuxt-auto-api/src/runtime/server/handlers - Bulk M2M Aggregate
packages/nuxt-auto-api/src/runtime/server/handlers
Request Controls
- Request Context
packages/nuxt-auto-api/src/runtime/server/handlers/createContextFromRegistry.ts - Authorization
packages/nuxt-auto-api/src/runtime/server/utils/permissions.ts - Tenant Scoping
packages/nuxt-auto-api/src/runtime/server/utils/tenant.ts - Schema Validation
packages/nuxt-auto-api/src/runtime/server/validation/schemaGenerator.ts
Admin Experience
- Admin Resource UI
packages/nuxt-auto-admin/src/runtime/components/ResourceTable.vue - Admin Forms
packages/nuxt-auto-admin/src/runtime/components/ResourceForm.vue - Admin Permissions
packages/nuxt-auto-admin/src/runtime/composables/useAdminPermissions.ts - Admin Dashboard
packages/nuxt-auto-admin/src/runtime/components/AdminDashboardWidget.vue
Data and Extensions
- API Plugins
packages/nuxt-auto-api/src/runtime/server/plugins/pluginRegistry.ts - Database Adapters
packages/nuxt-auto-api/src/runtime/server/database/adapters - Drizzle Database
packages/nuxt-auto-api/src/runtime/server/database/index.ts - Export Audit Upload
packages/nuxt-auto-api/src/runtime/server/handlers/plugins
Other components
- User or App
Connections 22
- User or App → Admin Resource UI: manages resources
README.md - User or App → Typed API Queries: queries resources
README.md - Drizzle Schema → API Module: generates resources
README.md - Drizzle Schema → Admin Module: generates panel
README.md - Typed API Queries → Generated API Routes: fetches API
packages/nuxt-auto-api/src/runtime/composables/useAutoApiQuery.ts - Generated API Routes → Request Context: builds context
packages/nuxt-auto-api/src/runtime/server/handlers/pipeline.ts - Generated API Routes → Resource Operations: executes operation
packages/nuxt-auto-api/src/runtime/server/handlers/pipeline.ts - Request Context → Authorization: authorizes request
packages/nuxt-auto-api/src/runtime/server/handlers/createContextFromRegistry.ts - Request Context → Tenant Scoping: resolves tenant
packages/nuxt-auto-api/src/runtime/server/handlers/createContextFromRegistry.ts - Request Context → Schema Validation: creates validator
packages/nuxt-auto-api/src/runtime/server/handlers/createContextFromRegistry.ts - Generated API Routes → Schema Validation: validates request
packages/nuxt-auto-api/src/runtime/server/handlers/pipeline.ts - Resource Operations → Drizzle Database: reads and writes
packages/nuxt-auto-api/src/runtime/server/handlers/createContextFromRegistry.ts - Bulk M2M Aggregate → Drizzle Database: queries relations
README.md - API Module → Bulk M2M Aggregate: provides operations
README.md - API Module → API Plugins: registers extensions
- API Plugins → Export Audit Upload: enables routes
- Drizzle Database → Database Adapters: uses engine adapter
README.md - Admin Module → Admin Resource UI: generates interface
README.md - Admin Resource UI → Typed API Queries: loads resources
README.md - Admin Forms → Typed API Queries: submits changes
README.md - Admin Permissions → Typed API Queries: checks permissions
README.md - Admin Dashboard → Typed API Queries: loads dashboard data