Skip to content

Commit 1ec3681

Browse files
committed
Add Shadcn Admin Kit Readme
1 parent 6ac5426 commit 1ec3681

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

src/components/admin/Readme.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Admin Components
2+
3+
The components in this directory come from [Shadcn Admin Kit](https://marmelab.com/shadcn-admin-kit/). They are application building blocks providing solution to usual single-page apps needs, including:
4+
5+
- data fetching,
6+
- lists and data tables,
7+
- forms & validation,
8+
- authentication,
9+
- search & filtering,
10+
- i18n,
11+
- theming,
12+
- loading and error management.
13+
- rapid CRUD generation,
14+
- ralationship management,
15+
- roles & permissions,
16+
- optimistic UI,
17+
- undo functionality,
18+
- bulk actions,
19+
- user preferences,
20+
- notifications,
21+
- and more.
22+
23+
These components are built on top of [TanStack Query](https://tanstack.com/query/latest), [React Hook Form](https://react-hook-form.com/), [React Router](https://reactrouter.com/), [ra-core](https://marmelab.com/ra-core/), [Radix UI](https://www.radix-ui.com/) and [Shadcn UI](https://ui.shadcn.com/).
24+
25+
In Atomic CRM, these components are sometimes slightly modified to fit the look and feel of the application.
26+
27+
## Documentation
28+
29+
You can find the documentation for these components on the [Shadcn Admin Kit website](https://marmelab.com/shadcn-admin-kit/docs).
30+
31+
## Updates
32+
33+
Shadcn Admin Kit components are actively maintained and updated. To update the components in Atomic CRM, type the following command:
34+
35+
```
36+
npx shadcn@latest add -o https://marmelab.com/shadcn-admin-kit/r/shadcn-admin-kit-base.json
37+
```
38+

0 commit comments

Comments
 (0)