ding-react-admin 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Muhammad Inaam Munir
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,74 @@
+# ding-react-admin
+
+**Live demo:** [playground on GitHub Pages](https://muhammadinaam.github.io/ding-react-admin/) (login: `admin` / `admin` or `user` / `user`)
+
+Composable admin shell for React apps: **Ant Design 6** layout, **CRUD field system** (lists, forms, filters, inlines, bulk actions), **theme/density** controls, **`AuthProvider`** + **`useAuth`**, **data / permissions providers** (react-admin–style naming, intentionally small), and **React Router** helpers.
+
+## Providers (manual composition)
+
+Nothing is wired automatically except theme inside `<AdminApp />`. Wrap providers yourself:
+
+| Provider | Required for |
+|----------|----------------|
+| **`AuthProvider`** | Login, logout, route guards (`Protected`, `GuestOnly`), `useAuth` |
+| **`DataProvider`** | CRUD components (`ResourceList`, `ResourceForm`, …) |
+| **`PermissionsProvider`** | Permission gating in CRUD (`usePermissions`, `useCan`) |
+
+**Auth only** (custom pages, no CRUD yet):
+
+```tsx
+<AuthProvider adapter={createSessionStorageAuthAdapter()}>
+  <AdminApp navItems={nav} routes={routes} />
+</AuthProvider>
+```
+
+**Full stack** (CRUD + permissions) — see [docs/data-permissions.md](docs/data-permissions.md) and [`examples/playground/src/main.tsx`](examples/playground/src/main.tsx):
+
+```tsx
+<AuthProvider adapter={authAdapter}>
+  <DataProvider value={dataProvider}>
+    <PermissionsProvider can={permissions}>
+      <AdminApp navItems={nav} routes={routes} />
+    </PermissionsProvider>
+  </DataProvider>
+</AuthProvider>
+```
+
+Use **`createSessionStorageAuthAdapter`** for demos; replace with an adapter that calls your API in production. Implement **`AuthAdapter.login`** with a **`LoginCredentials`** object (`username`, `password`, plus any extra fields your login form needs, e.g. `businessId`).
+
+## Getting started
+
+**New to CRUD:** [docs/tutorial-one-entity.md](docs/tutorial-one-entity.md) — full walkthrough from `yarn create vite` through Users list/form, `data-provider.ts`, and routes.
+
+**Quick path:** [docs/quick-start.md](docs/quick-start.md) — `<AuthProvider>` + `<AdminApp />` with declarative routes.
+
+**Full control:** [docs/composition.md](docs/composition.md) and the [playground](examples/playground/src/main.tsx) — your own `createBrowserRouter` with `AdminLayout`, `Protected`, `GuestOnly`, `DataProvider`, and `PermissionsProvider`.
+
+## Documentation
+
+| Topic | Guide |
+|-------|--------|
+| Install & peer deps | [docs/install.md](docs/install.md) |
+| **Tutorial: add one CRUD entity** | [docs/tutorial-one-entity.md](docs/tutorial-one-entity.md) |
+| Example playground app | [docs/example-app.md](docs/example-app.md) |
+| Sidebar navigation | [docs/navigation.md](docs/navigation.md) |
+| CRUD overview | [docs/crud/overview.md](docs/crud/overview.md) |
+| List pages & filters | [docs/crud/list-pages.md](docs/crud/list-pages.md) |
+| **Bulk actions** (Django-style) | [docs/crud/bulk-actions.md](docs/crud/bulk-actions.md) |
+| Form pages | [docs/crud/forms.md](docs/crud/forms.md) |
+| Reference / lookup fields | [docs/crud/references.md](docs/crud/references.md) |
+| Inline nested forms | [docs/crud/inlines.md](docs/crud/inlines.md) |
+| Custom field types | [docs/crud/custom-fields.md](docs/crud/custom-fields.md) |
+| Data layer & permissions | [docs/data-permissions.md](docs/data-permissions.md) |
+| **Form validation errors** | [docs/form-validation-errors.md](docs/form-validation-errors.md) |
+| **Routing & auth guards** | [docs/routing.md](docs/routing.md) |
+| Login / register layout | [docs/auth-pages.md](docs/auth-pages.md) |
+| Quick start (`<AdminApp />`) | [docs/quick-start.md](docs/quick-start.md) |
+| Composition (your own router) | [docs/composition.md](docs/composition.md) |
+| Odoo-style app hub | [docs/app-hub.md](docs/app-hub.md) |
+| `createAdminRouter` shortcut | [docs/admin-router.md](docs/admin-router.md) |
+| Developing next to your app (Vite) | [docs/developing.md](docs/developing.md) |
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";