Skip to content

A full-featured CRM built with React, shadcn/ui, and Supabase.

Improve documentation

fzaninotto475203d9732b
diff --git a/.gitignore b/.gitignore
index 334ff6e4..8bba9ca2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -33,3 +33,4 @@ dist/
/lib/
.env
*storybook.log
+.claude
\ No newline at end of file
diff --git a/doc/src/content/docs/developers/architecture-choices.mdx b/doc/src/content/docs/developers/architecture-choices.mdx
index f6f6a4f8..83db92fa 100644
--- a/doc/src/content/docs/developers/architecture-choices.mdx
+++ b/doc/src/content/docs/developers/architecture-choices.mdx
@@ -20,6 +20,19 @@ The frontend is a Single-Page Application built with [Shadcn Admin Kit](https://
For the backend, Atomic CRM leverages [Supabase](https://supabase.com/). Supabase provides a PostgreSQL database, a REST API, authentication, storage, and edge functions. In practice, this means that there is very little backend code to maintain (a few edge functions for user management and inbound email processing).
+## Mutable Dependencies
+
+The Atomic CRM code primarily lives in the `src/atomic-crm` directory. With less than 15,000 lines of code, it is a small codebase that can be easily customized.
+
+The Atomic CRM code also contains some mutable dependencies, i.e. libraries that are directly integrated into the codebase to be modified if needed. These dependencies are located in the following directories:
+
+- `src/components/admin`: [Shadcn Admin Kit](https://marmelab/shadcn-admin-kit), providing the frontend architecture and the glue code to integrate the various libraries.
+- `src/copmponents/ui`: [Shadcn UI](https://ui.shadcn.com/), providing beautiful, accessible, and customizable components powered by Tailwind CSS.
+
+You can modify or replaces the files in these directories. It's the recommended way to customize the application.
+
+If you want to upgrade these dependencies, you can follow the instructions in their respective documentation.
+
## Views
Some pages in Atomic CRM require data from multiple tables. To simplify the frontend code and reduce the HTTP overhead, Atomic CRM uses database views to abstract the complexity of the queries.
diff --git a/doc/src/content/docs/developers/customizing.mdx b/doc/src/content/docs/developers/customizing.mdx
index feffb88a..ee75e754 100644
--- a/doc/src/content/docs/developers/customizing.mdx
+++ b/doc/src/content/docs/developers/customizing.mdx
@@ -1,5 +1,5 @@
---
-title: Customizing Atomic CRM
+title: Configuration
description: This document explains how to customize the Atomic CRM application.
---
diff --git a/doc/src/content/docs/developers/data-providers.mdx b/doc/src/content/docs/developers/data-providers.mdx
index 0be11aaa..42f091e7 100644
--- a/doc/src/content/docs/developers/data-providers.mdx
+++ b/doc/src/content/docs/developers/data-providers.mdx
@@ -19,11 +19,23 @@ To import the test data, follow these steps:
For development purposes, you can use an alternative data provider called [FakeRest](https://github.com/marmelab/FakeRest). It's a simple REST API running in the browser that resets the data on each page reload. It's useful for testing the frontend without having to set up a backend, e.g. to let end users test some updates before the backend is ready.
+### Running The App With FakeRest
+
+Type the following command to start the application with the FakeRest data provider:
+
+```bash
+npm run dev:demo
+```
+
+This will start the application on [http://localhost:5173/](http://localhost:5173/) using FakeRest as the data provider. You will be logged in as a demo user with admin rights.
+
+:::tip
FakeRest is used in the [Atomic CRM demo](https://marmelab.com/atomic-crm-demo/), where you can test it live.
+:::
### Setting Up The FakeRest Data Provider
-To set up the FakeRest data provider, you need to change the `dataProvider` import in the `src/App.tsx` file:
+If you want to set up the FakeRest data provider manually, you need to change the `dataProvider` import in the `src/App.tsx` file:
```diff
// in App.tsx
diff --git a/doc/src/content/docs/index.mdx b/doc/src/content/docs/index.mdx
index f277c4ee..43950334 100644
--- a/doc/src/content/docs/index.mdx
+++ b/doc/src/content/docs/index.mdx
@@ -64,9 +64,9 @@ If you need debug the backend, you can access the following services:
When you first access the application at [http://localhost:5173/](http://localhost:5173/), you will be prompted to create the first admin user. This user will have full access to the application and will be able to manage other users.
-Once the admin user is created, you will be redirected to the dashboard. It's currently showing an onboarding screen to help you get started as long as there is no data in the database.
+<video src="https://github.com/user-attachments/assets/2e5fa809-bd46-4ea1-926f-6f53358de681" controls className="w-full aspect-884/724"></video>
-![Onboarding Screen](../images/onboarding.png)
+Once the admin user is created, you will be redirected to the dashboard. It's currently showing an onboarding screen to help you get started as long as there is no data in the database.
## Bootstrapping with Sample Data
diff --git a/doc/src/content/docs/users/import-contacts.mdx b/doc/src/content/docs/users/import-contacts.mdx
index 7d586c61..55a387b8 100644
--- a/doc/src/content/docs/users/import-contacts.mdx
+++ b/doc/src/content/docs/users/import-contacts.mdx
@@ -3,15 +3,14 @@ title: Importing and Exporting Contacts
description: This document explains how to import and export contacts in Atomic CRM.
---
-## Importing Data
+You can import and export contacts and companies from and to a CSV file, e.g. to migrate from another CRM.
-You can import contacts and companies from a CSV file, e.g. to migrate from another CRM.
+## Importing Data
+Atomic CRM displays an import contact buttons in the initial user onboarding page, and in the contacts page. When clicking on it, a modal is displayed to upload a CSV file.
<video src="https://github.com/user-attachments/assets/a1133cf0-0287-4fc0-b61b-5a0b88617cfc" controls className="w-full aspect-1304/814"></video>
-Atomic CRM displays an import contact buttons in the initial user onboarding page, and in the contacts page.
-
An example of the expected CSV file is available in the contact import modal:
```csv
@@ -25,3 +24,5 @@ When importing contacts, companies and tags will be automatically matched if the
## Exporting Data
In the contacts and companies pages, an export button allows to download the list of contacts or companies in CSV format.
+
+![Import and export Buttons](../../images/import-export.jpg)
diff --git a/doc/src/content/docs/users/inbound-email.mdx b/doc/src/content/docs/users/inbound-email.mdx
index e9f249e6..33524393 100644
--- a/doc/src/content/docs/users/inbound-email.mdx
+++ b/doc/src/content/docs/users/inbound-email.mdx
@@ -13,7 +13,9 @@ You must setup Postmark and Supabase to use the inbound email feature. Check the
Send of forward emails to Atomic CRM's inbound email address to automatically add notes to the corresponding contacts. You can find this email address in the user menu by clicking on the "My Info" menu item, in the "Inbound Email" section. It looks like `[email protected]`.
-Atomic CRM uses the sender's email address to identify the user member, and the recipient's email address to identify the contact. If the contact does not yet exist, Atomic CRM creates it using the email's domain as company name.
+![Inbound Email Address](../../images/inbound-email.jpg)
+
+When you write to a contact in your email client, add the inbound email address in the **Bcc** field. PPostmark will receive a copy of your email, and forward it to Atomic CRM. Atomic CRM uses the sender's email address to identify the user, and the recipient's email address to identify the contact. If the contact does not yet exist, Atomic CRM creates it using the email's domain as company name. The content of the email is added as a note to the contact.
**Tip**: Use the **Bcc** field to send emails to Atomic CRM without notifying the recipients.
diff --git a/doc/src/content/images/import-export.jpg b/doc/src/content/images/import-export.jpg
new file mode 100644
index 00000000..3ab1d40e
Binary files /dev/null and b/doc/src/content/images/import-export.jpg differ
diff --git a/doc/src/content/images/inbound-email.jpg b/doc/src/content/images/inbound-email.jpg
new file mode 100644
index 00000000..4a71e5d5
Binary files /dev/null and b/doc/src/content/images/inbound-email.jpg differ