Skip to content

Commit ba8267e

Browse files
committed
Add README files for Admin and UI components
1 parent 1ec3681 commit ba8267e

File tree

2 files changed

+38
-2
lines changed

2 files changed

+38
-2
lines changed

src/components/admin/Readme.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@ The components in this directory come from [Shadcn Admin Kit](https://marmelab.c
2222

2323
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/).
2424

25-
In Atomic CRM, these components are sometimes slightly modified to fit the look and feel of the application.
26-
2725
## Documentation
2826

2927
You can find the documentation for these components on the [Shadcn Admin Kit website](https://marmelab.com/shadcn-admin-kit/docs).
3028

29+
## Customization
30+
31+
In Atomic CRM, these components are sometimes slightly modified to fit the look and feel of the application. You can customize them further by editing the source files in this directory.
32+
3133
## Updates
3234

3335
Shadcn Admin Kit components are actively maintained and updated. To update the components in Atomic CRM, type the following command:

src/components/ui/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# UI Components
2+
3+
The components in this directory come from [shadcn/ui](https://ui.shadcn.com/). They are low-level building blocks for creating user interfaces, including:
4+
5+
- Badges
6+
- Buttons
7+
- Cards
8+
- Dialogs
9+
- Forms Inputs
10+
- Navigation MMenus
11+
- Tables
12+
- Tabs
13+
- Tooltips
14+
- And more...
15+
16+
These components are built on top of [Radix UI](https://www.radix-ui.com/) and styled using [Tailwind CSS](https://tailwindcss.com/).
17+
18+
## Documentation
19+
20+
You can find the documentation for these components on the [shadcn/ui website](https://ui.shadcn.com/docs).
21+
22+
## Customization
23+
24+
In Atomic CRM, these components are sometimes slightly modified to fit the look and feel of the application. You can customize them further by editing the source files in this directory.
25+
26+
## Updates
27+
28+
Shadcn/ui components are actively maintained and updated. To add or update a UI component in Atomic CRM, type the following command:
29+
30+
```
31+
npx shadcn@latest add [component-name]
32+
```
33+
34+
The admin components have a dependency on some ui components, so if you update the admin components, this will also update the ui components. Check [the admin components readme](../admin/Readme.md) for the command to update them.

0 commit comments

Comments
 (0)