# VUEDA

> Integrator guides and API reference for VUEDA's Django server and Vue client.

Start with the guide for your task, then follow its API links for signatures and supported options.
Reference indexes link to individual Markdown pages. This site follows one evolving major version;
check the package changelog or installed API when a feature may be newer than your installation.

## Getting Started

- [Start Building](https://vueda.dev/v3/tutorials/start-building.md): Set up an application with the VUEDA server and client.
- [Use VUEDA with Coding Agents](https://vueda.dev/v3/guides/use-coding-agents.md): Install the using-vueda skill and look up documentation from a coding agent.
- [Build business applications with Django and Vue](https://vueda.dev/v3/index.md): Turn Django models, serializers, and viewsets into Vue forms, lists, and detail screens. Add workflows, permissions, and audit history with VUEDA.

## Tutorials

- [Add Workflow to a Model](https://vueda.dev/v3/tutorials/add-workflow.md)
- [Tutorials](https://vueda.dev/v3/tutorials/index.md)

## Core Concepts

- [Action Contract and Availability](https://vueda.dev/v3/core-concepts/action-contract-and-availability.md)
- [Architecture Overview](https://vueda.dev/v3/core-concepts/architecture-overview.md)
- [Authorization vs UI Semantics](https://vueda.dev/v3/core-concepts/authorization-vs-ui-semantics.md)
- [Cancellable Network Operations](https://vueda.dev/v3/core-concepts/cancellable-network-operations.md)
- [Canonical Registration and Model Discovery](https://vueda.dev/v3/core-concepts/canonical-registration-and-discovery.md)
- [Configuration Surface and Defaults](https://vueda.dev/v3/core-concepts/configuration-surface-and-defaults.md)
- [Contract-First Dynamic UI](https://vueda.dev/v3/core-concepts/contract-first-dynamic-ui.md)
- [CRUD Adapter Layer](https://vueda.dev/v3/core-concepts/crud-adapter-layer.md)
- [DRF Ecosystem Compatibility Boundaries](https://vueda.dev/v3/core-concepts/drf-ecosystem-deviations.md)
- [Error and Validation Contract](https://vueda.dev/v3/core-concepts/error-and-validation-contract.md)
- [Field and Expand Semantics](https://vueda.dev/v3/core-concepts/field-and-expand-semantics.md)
- [Filtering and Ordering Semantics](https://vueda.dev/v3/core-concepts/filtering-and-ordering-semantics.md)
- [Form State and Validation Lifecycle](https://vueda.dev/v3/core-concepts/form-state-and-validation-lifecycle.md)
- [Core Concepts](https://vueda.dev/v3/core-concepts/index.md)
- [Model Feature Policy](https://vueda.dev/v3/core-concepts/model-feature-policy.md)
- [Model History Response](https://vueda.dev/v3/core-concepts/model-history-response.md)
- [Nested Write Compatibility](https://vueda.dev/v3/core-concepts/nested-write-compatibility.md)
- [Permission Model (CRUD + Object + State)](https://vueda.dev/v3/core-concepts/permission-model.md)
- [Primary Key and Identifier Discipline](https://vueda.dev/v3/core-concepts/pk-and-identifier-discipline.md)
- [Reactive Data Flow (Stores + Composables)](https://vueda.dev/v3/core-concepts/reactive-data-flow.md)
- [Routing and View Resolution Model](https://vueda.dev/v3/core-concepts/routing-and-view-resolution-model.md)
- [Row-Level Permission Filtering](https://vueda.dev/v3/core-concepts/row-level-permission-filtering.md)
- [Server-Client Metadata Contract](https://vueda.dev/v3/core-concepts/server-client-metadata-contract.md)
- [Theming and Customization](https://vueda.dev/v3/core-concepts/theming-and-customization.md)
- [VDQ and Background Work Model](https://vueda.dev/v3/core-concepts/vdq-and-background-work.md)
- [Workflow as a Permission Overlay](https://vueda.dev/v3/core-concepts/workflow-permission-overlay.md)

## Guides

- [Build Auth Views](https://vueda.dev/v3/guides/build-auth-views.md)
- [Choice-Backed Fields and Lookup Models](https://vueda.dev/v3/guides/choices-and-lookups.md)
- [Client Plugin Prerequisites](https://vueda.dev/v3/guides/client-plugin-prerequisites.md)
- [Set Up CRUD for a Composite Primary Key Model](https://vueda.dev/v3/guides/composite-primary-keys.md)
- [Configure the Cache and Sessions](https://vueda.dev/v3/guides/configure-cache-and-sessions.md)
- [Configure \`list\`/\`read\`/\`create\`/\`update\` Views](https://vueda.dev/v3/guides/configure-crud-views.md)
- [Control Action Availability in the UI](https://vueda.dev/v3/guides/control-action-availability.md)
- [Create a CRUD Surface for a New Model](https://vueda.dev/v3/guides/create-crud-surface.md)
- [Create a CRUDL Surface for a New Model](https://vueda.dev/v3/guides/create-crudl-surface.md)
- [Customize Field and Widget Rendering](https://vueda.dev/v3/guides/custom-field-widget-rendering.md)
- [Customize List Column Rendering](https://vueda.dev/v3/guides/customize-list-column-rendering.md)
- [Customize Model Info Field and Expand Metadata](https://vueda.dev/v3/guides/customize-model-info-metadata.md)
- [Customize VUEDA Appearance](https://vueda.dev/v3/guides/customize-vueda-appearance.md)
- [Data That VUEDA Does Not Display](https://vueda.dev/v3/guides/data-vueda-does-not-display.md)
- [Declare List Ordering](https://vueda.dev/v3/guides/declare-list-ordering.md)
- [Use Expand and Sparse Field Controls](https://vueda.dev/v3/guides/expand-and-fields-controls.md)
- [Handle Form Validation and Server Errors](https://vueda.dev/v3/guides/form-validation-and-errors.md)
- [Lock Fields to Specific Write Actions](https://vueda.dev/v3/guides/hide-fields-per-write-action.md)
- [Implement Row-Level Permissions](https://vueda.dev/v3/guides/implement-row-level-permissions.md)
- [Guides](https://vueda.dev/v3/guides/index.md)
- [Link List Rows to Read and Update Views](https://vueda.dev/v3/guides/link-list-rows-to-detail-views.md)
- [Expose Aggregates in \`list\` Responses](https://vueda.dev/v3/guides/list-column-totals.md)
- [Local HTTPS Development](https://vueda.dev/v3/guides/local-https-setup.md)
- [Manage Groups and Generate Group Migrations](https://vueda.dev/v3/guides/manage-groups.md)
- [Manage Workflows and Generate Workflow Migrations](https://vueda.dev/v3/guides/manage-workflows.md)
- [Build Nested/Inlined Writes](https://vueda.dev/v3/guides/nested-writable-inlines.md)
- [Map Django and VUEDA Permission Names](https://vueda.dev/v3/guides/permission-name-mapping.md)
- [Use the Permissions and Workflow Overview](https://vueda.dev/v3/guides/permissions-workflow-overview.md)
- [Place the Page Title and Page Actions](https://vueda.dev/v3/guides/place-page-title-and-actions.md)
- [Expose a Proxy Model as a Separate CRUD Surface](https://vueda.dev/v3/guides/proxy-models.md)
- [Purge Model History Rows](https://vueda.dev/v3/guides/purge-model-history.md)
- [Render a Relation as an Inline](https://vueda.dev/v3/guides/render-relations-as-inlines.md)
- [Require Confirmation Before a Write](https://vueda.dev/v3/guides/require-write-confirmation.md)
- [Open a Scoped List](https://vueda.dev/v3/guides/scope-a-list.md)
- [shadcn-vue and VUEDA](https://vueda.dev/v3/guides/shadcn-vue.md)
- [Split Read/Write Serializers Safely](https://vueda.dev/v3/guides/split-read-write-serializers.md)
- [Style Unovis Charts](https://vueda.dev/v3/guides/style-unovis-charts.md)
- [Design Transition UX and Redirects](https://vueda.dev/v3/guides/transition-ux-and-redirects.md)
- [Upgrade from VUEDA v2](https://vueda.dev/v3/guides/upgrade-from-v2.md)
- [Set Up and Operate the VUEDA Dispatch Queue (VDQ)](https://vueda.dev/v3/guides/vdq-actions.md)
- [Send Email from VDQ with Anymail](https://vueda.dev/v3/guides/vdq-email-anymail.md)
- [Send SMS from VDQ with Twilio](https://vueda.dev/v3/guides/vdq-sms-twilio.md)
- [Add Workflow State and Transition Permissions](https://vueda.dev/v3/guides/workflow-state-permissions.md)

## Reference

- [API Reference](https://vueda.dev/v3/reference/api/index.md): Browse the API reference by language and component type.
- [JavaScript API](https://vueda.dev/v3/reference/api/js/index.md): JavaScript functions, stores, and types.
- [Python API](https://vueda.dev/v3/reference/api/py/index.md): Python classes, functions, and modules.
- [REST API](https://vueda.dev/v3/reference/api/rest/index.md): HTTP endpoints and request and response schemas.
- [Vue Components](https://vueda.dev/v3/reference/api/vue/index.md): Vue components, props, events, and slots.
- [Components](https://vueda.dev/v3/reference/components/index.md): Component guides organized by purpose.
- [Server configuration](https://vueda.dev/v3/reference/configuration.md)
- [Glossary](https://vueda.dev/v3/reference/glossary.md)
- [Reference](https://vueda.dev/v3/reference/index.md)
- [Permissions](https://vueda.dev/v3/reference/permissions.md)
- [Theming](https://vueda.dev/v3/reference/theming.md): Theme structure and customization reference.
- [Theme keys](https://vueda.dev/v3/reference/theming/keys.md): Theme keys grouped by component family.
- [Theme tokens](https://vueda.dev/v3/reference/theming/tokens.md): CSS custom properties grouped by purpose.

## Symbol Lookup

- [Symbol index](https://vueda.dev/v3/symbols.json): Download and search locally for known identifiers; do not load the whole index into context. JSON contains a version field and a symbols array with id, name, and url fields. URLs point to Markdown pages and member anchors.

## Optional

- [Client](https://vueda.dev/v3/reference/changelog/client.md)
- [Changelog](https://vueda.dev/v3/reference/changelog/index.md)
- [Server](https://vueda.dev/v3/reference/changelog/server.md)
- [Complete documentation](https://vueda.dev/v3/llms-full.txt): All published Markdown in one large file. Prefer individual pages for ordinary lookups.