Skip to content

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

Document import feature

François Zaninotto78769561ec7b
diff --git a/README.md b/README.md
index a5bf0b59..ce88d81d 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,9 @@
A full-featured CRM built with React, shadcn-admin-kit, and Supabase.
-https://github.com/user-attachments/assets/0d7554b5-49ef-41c6-bcc9-a76214fc5c99
+<https://github.com/user-attachments/assets/0d7554b5-49ef-41c6-bcc9-a76214fc5c99>
-Atomic CRM is free and open-source. You can test it online at https://marmelab.com/atomic-crm-demo.
+Atomic CRM is free and open-source. You can test it online at <https://marmelab.com/atomic-crm-demo>.
## Features
@@ -52,33 +52,16 @@ This will start the Vite dev server for the frontend, the local Supabase instanc
You can then access the app via [http://localhost:5173/](http://localhost:5173/). You will be prompted to create the first user.
-If you need debug the backend, you can access the following services:
+If you need debug the backend, you can access the following services:
- Supabase dashboard: [http://localhost:54323/](http://localhost:54323/)
- REST API: [http://127.0.0.1:54321](http://127.0.0.1:54321)
- Attachments storage: [http://localhost:54323/project/default/storage/buckets/attachments](http://localhost:54323/project/default/storage/buckets/attachments)
- Inbucket email testing service: [http://localhost:54324/](http://localhost:54324/)
-## User Documentation
+## Documentation
-1. [User Management](./doc/src/content/docs/users/user-management.mdx)
-2. [Importing And Exporting Data](./doc/src/content/docs/users/import-contacts.mdx)
-3. [Inbound Email](./doc/src/content/docs/users/inbound-email.mdx)
-
-## Deploying to Production
-
-1. [Configuring Supabase](./doc/src/content/docs/developers/supabase-configuration.mdx)
-2. [Configuring Inbound Email](./doc/src/content/docs/developers/inbound-email-configuration.mdx) *(optional)*
-3. [Deployment](./doc/src/content/docs/developers/deploy.mdx)
-
-## Customizing Atomic CRM
-
-To customize Atomic CRM, you will need TypeScript and React programming skills as there is no graphical user interface for customization. Here are some resources to assist you in getting started.
-
-1. [Customizing the CRM](./doc/src/content/docs/developers/customizing.mdx)
-2. [Creating Migrations](./doc/src/content/docs/developers/migrations.mdx) *(optional)*
-3. [Using Fake Rest Data Provider for Development](./doc/src/content/docs/developers/data-providers.mdx) *(optional)*
-4. [Architecture Decisions](./doc/src/content/docs/developers/architecture-choices.mdx) *(optional)*
+The user and developer documentation for this project is available [in the `doc/` directory](./doc/). You can also read it online at [https://marmelab.com/atomic-crm/doc/](https://marmelab.com/atomic-crm/doc/).
## Testing Changes
@@ -93,6 +76,7 @@ You can add your own unit tests powered by Jest anywhere in the `src` directory.
## Registry
Atomic CRM components are published as a Shadcn Registry file:
+
- The `registry.json` file is automatically generated by the `scripts/generate-registry.mjs` script as a pre-commit hook.
- The `http://marmelab.com/atomic-crm/r/atomic-crm.json` file is automatically published by the CI/CD pipeline
diff --git a/doc/astro.config.mjs b/doc/astro.config.mjs
index 2dc8bb7f..9ac89132 100644
--- a/doc/astro.config.mjs
+++ b/doc/astro.config.mjs
@@ -86,7 +86,7 @@ export default defineConfig({
label: "Users Documentation",
items: [
"users/user-management",
- "users/import-contacts",
+ "users/import-data",
"users/merging-contacts",
"users/inbound-email",
"users/mcp-server",
diff --git a/doc/src/content/docs/users/import-contacts.mdx b/doc/src/content/docs/users/import-contacts.mdx
deleted file mode 100644
index de8e7844..00000000
--- a/doc/src/content/docs/users/import-contacts.mdx
+++ /dev/null
@@ -1,32 +0,0 @@
----
-title: Importing and Exporting Contacts
-description: This document explains how to import and export contacts in Atomic CRM.
----
-
-You can import and export contacts and companies from and to 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>
-
-An example of the expected CSV file is available in the contact import modal:
-
-```csv
-first_name,last_name,gender,title,background,first_seen,last_seen,has_newsletter,status,tags,linkedin_url,company,email_work,email_home,email_other,phone_work,phone_home,phone_other
-John,Doe,male,Sales Executive,,2024-07-01T00:00:00+00:00,2024-07-01T11:54:49.95+00:00,false,in-contract,"influencer, developer",https://www.linkedin.com/in/johndoe,Acme,[email protected],[email protected],[email protected],659-980-2015,740.645.3807,(446) 758-2122
-Jane,Doe,female,Designer,,2024-07-01T00:00:00+00:00,2024-07-01T11:54:49.95+00:00,false,in-contract,"UI, design",https://www.linkedin.com/in/janedoe,Acme,,,[email protected],659-980-2020,740.647.3802,
-```
-
-When importing contacts, companies and tags will be automatically matched if they exist on the system, or imported otherwise.
-
-## 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)
-
-You can also export a single contact as a vCard file from the aside panel in the Contact Edit page.
-
-![Export to vCard Button](../../images/export-contact.png)
\ No newline at end of file
diff --git a/doc/src/content/docs/users/import-data.mdx b/doc/src/content/docs/users/import-data.mdx
new file mode 100644
index 00000000..43d523f7
--- /dev/null
+++ b/doc/src/content/docs/users/import-data.mdx
@@ -0,0 +1,77 @@
+---
+title: Importing and Exporting Data
+description: This document explains how to import and export contacts in Atomic CRM.
+---
+
+Whether you are starting to use Atomic CRM, or want to migrate from another CRM, you can import your contacts, companies, tasks, notes, tags and deals in a few clicks. You can also export your contacts and companies in CSV format, and your contacts as vCard files.
+
+## Import Contacts From CSV
+
+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>
+
+An example of the expected CSV file is available in the contact import modal:
+
+```csv
+first_name,last_name,gender,title,background,first_seen,last_seen,has_newsletter,status,tags,linkedin_url,company,email_work,email_home,email_other,phone_work,phone_home,phone_other
+John,Doe,male,Sales Executive,,2024-07-01T00:00:00+00:00,2024-07-01T11:54:49.95+00:00,false,in-contract,"influencer, developer",https://www.linkedin.com/in/johndoe,Acme,[email protected],[email protected],[email protected],659-980-2015,740.645.3807,(446) 758-2122
+Jane,Doe,female,Designer,,2024-07-01T00:00:00+00:00,2024-07-01T11:54:49.95+00:00,false,in-contract,"UI, design",https://www.linkedin.com/in/janedoe,Acme,,,[email protected],659-980-2020,740.647.3802,
+```
+
+When importing contacts, companies and tags will be automatically matched if they exist on the system, or imported otherwise.
+
+## Export Contacts To CSV
+
+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)
+
+## Export Contacts To vCard
+
+You can also export a single contact as a vCard file from the aside panel in the Contact Edit page.
+
+![Export to vCard Button](../../images/export-contact.png)
+
+## Migrating From Another CRM
+
+Atomic CRM allows to import contacts, companies, tasks, notes, tags and deals from a single JSON file. You can create this JSON file from the export of your previous CRM. The expected format of the JSON file looks like the following:
+
+```json
+{
+ "sales": [
+ { "id": 123, "first_name": "John", "last_name": "Doe", "email": "[email protected]" }
+ ],
+ "companies": [
+ { "id": 234, "name": "A company" },
+ { "id": 345, "name": "Another company", "description": "A description", "city": "A city", "country": "A country", "address": "An address", "zipcode": "A zipcode", "state_abbr": "A state abbreviation", "sales_id": 123 }
+ ],
+ "contacts": [
+ { "id": 456, "first_name": "Jane", "last_name": "Smith" },
+ { "id": 567, "first_name": "A first name", "last_name": "A last name", "title": "A title", "company_id": 345, "background": "A background", "linkedin_url": "A URL", "sales_id": 123, "emails": [ { "email": "[email protected]", "type": "Work" } ], "phones": { "number": "45646746788", "type": "Home" }, "tags": ["MyTag"] }
+ ],
+ "notes": [
+ { "contact_id": 456, "sales_id": 123, "text": "Some text", "date": "2025-11-13T08:16:10Z" },
+ { "contact_id": 456, "sales_id": 123, "text": "Some long text with lines\n\nAnother line", "date": "2025-02-14T09:20:21Z", "attachments": [ { "url": "https://mycurrentcrm.com/files/link", "name": "important.pdf" } ] }
+ ],
+ "tasks": [
+ { "contact_id": 456, "sales_id": 123, "text": "A task title" },
+ { "contact_id": 456, "sales_id": 123, "text": "Another task title", "due_date": "2025-03-26T16:15:00Z", "done_date": "2025-04-01T09:00:00" }
+ ],
+}
+
+```
+
+To display the import page, click on the User menu in the top right corner, and click on "Import data".
+
+![Import data menu](../../images/import-data-menu.png)
+
+A form displays to upload a JSON file. You can download a sample JSON file to see the expected format.
+
+![Import data form](../../images/import-data-form.png)
+
+Once you launch the import, the page will show the progress of the import, and display any error if the import fails.
+
+![Import progress](../../images/import-data-progress.png)
+
+This migration tool will allow you to easily migrate from your previous CRM to Atomic CRM, and start using it in a few clicks.
\ No newline at end of file
diff --git a/doc/src/content/images/import-data-form.png b/doc/src/content/images/import-data-form.png
new file mode 100644
index 00000000..aae0e6c6
Binary files /dev/null and b/doc/src/content/images/import-data-form.png differ
diff --git a/doc/src/content/images/import-data-menu.png b/doc/src/content/images/import-data-menu.png
new file mode 100644
index 00000000..043f26f8
Binary files /dev/null and b/doc/src/content/images/import-data-menu.png differ
diff --git a/doc/src/content/images/import-data-progress.png b/doc/src/content/images/import-data-progress.png
new file mode 100644
index 00000000..e9862a44
Binary files /dev/null and b/doc/src/content/images/import-data-progress.png differ
diff --git a/makefile b/makefile
index f60b2282..29f1469d 100644
--- a/makefile
+++ b/makefile
@@ -70,6 +70,8 @@ typecheck:
doc-install:
@(cd doc && npm install)
+doc: doc-dev
+
doc-dev:
@(cd doc && npm run dev)