Skip to content

example-app.md

Latest commit

 

History

History
55 lines (37 loc) · 2.59 KB

example-app.md

File metadata and controls

55 lines (37 loc) · 2.59 KB
Raw

Example app in this repo

First time? Follow tutorial-one-entity.md Part 1 for a full REST walkthrough. This playground is the same folder layout with an in-memory API instead of fetch.

There is a Vite app under examples/playground: in-memory demo API (auth + products, brands, categories, invoices, lines), CRUD screens, wired DataProvider / PermissionsProvider, and demo users (admin/admin vs user/user).

From the repository root (one yarn install at the root is enough — playground deps are shared with the library’s devDependencies):

yarn install
yarn dev:example

For day-to-day work on the library, the playground uses a Vite alias to ../../src so changes hot-reload. Consumers installing from GitHub do not need that alias.

Per-entity data modules (playground pattern)

Each resource lives in a feature folder under examples/playground/src/pages/:

pages/products/
  Products.tsx      # UI only (ResourceList / ResourceForm)
  productData.ts    # getList / getOne / create / update / delete
  index.ts          # re-exports

examples/playground/src/api/playgroundDataProvider.ts is a thin composer:

import { combineResourceHandlers } from "ding-react-admin";
import { createProductHandlers, PRODUCT_RESOURCE } from "../pages/products";

return combineResourceHandlers(
  { [PRODUCT_RESOURCE]: createProductHandlers(ctx), /* … */ },
  { can, parseFormError: parsePlaygroundFormError },
);

Form validation demo: duplicate product SKU or invoice line quantity 0 (parseDjangoDRFFormErrors in playgroundDataProvider.ts).

The product form passes referenceForm + referencePermissions on brand/category fields for Django admin–style add modals.

Removing a resource: delete its folder, remove one line from the composer, and drop routes + nav entries.

For a REST API, use the same folder layout with createRestResourceHandlers — see tutorial-one-entity.md. Pages keep resource={PRODUCT_RESOURCE} and pathPrefix="/products" unchanged.

Library helpers:

  • combineResourceHandlers — compose entity handlers into a DataProvider
  • createRestResourceHandlers — thin CRUD glue; form source defines the payload
  • createMemoryResourceHandlers — in-memory CRUD for demos (defaults spread form data + id)
  • toDjangoRestOrdering / toODataOrderBy / toJsonApiSort — optional sort helpers for list
  • applyInMemoryListParams — filter / sort / paginate in-memory rows

← Back to README