Skip to content

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

Add telemetry

Gildas7be1d997fc5a
diff --git a/doc/developer/customizing.md b/doc/developer/customizing.md
index 1646f420..522da1e5 100644
--- a/doc/developer/customizing.md
+++ b/doc/developer/customizing.md
@@ -112,4 +112,24 @@ export const Dashboard = () => (
</CardContent>
</Card>
);
+```
+
+### Disabling Telemetry
+
+In production, atomic-crm applications send an anonymous request on mount to a telemetry server operated by Marmelab. You can see this request by looking at the Network tab of your browser DevTools:
+
+```
+https://atomic-crm-telemetry.marmelab.com/atomic-crm-telemetry
+```
+
+The only data sent to the telemetry server is the admin domain (e.g. “example.com”) - no personal data is ever sent, and no cookie is included in the response. The atomic-crm team uses these domains to track the usage of the framework.
+
+You can opt out of telemetry by simply adding `disableTelemetry` to the `<CRM>` component:
+
+```tsx
+import { CRM } from './root/CRM';
+
+const App = () => <CRM disableTelemetry />;
+
+export default App;
```
\ No newline at end of file
diff --git a/src/root/CRM.tsx b/src/root/CRM.tsx
index 18836e5b..759cf3d9 100644
--- a/src/root/CRM.tsx
+++ b/src/root/CRM.tsx
@@ -1,3 +1,4 @@
+import { useEffect } from 'react';
import {
Admin,
CustomRoutes,
@@ -127,55 +128,76 @@ export const CRM = ({
title = defaultTitle,
dataProvider = defaultDataProvider,
authProvider = defaultAuthProvider,
+ disableTelemetry,
...rest
-}: CRMProps) => (
- <ConfigurationProvider
- contactGender={contactGender}
- companySectors={companySectors}
- dealCategories={dealCategories}
- dealPipelineStatuses={dealPipelineStatuses}
- dealStages={dealStages}
- logo={logo}
- noteStatuses={noteStatuses}
- taskTypes={taskTypes}
- title={title}
- >
- <Admin
- dataProvider={dataProvider}
- authProvider={authProvider}
- store={localStorageStore(undefined, 'CRM')}
- layout={Layout}
- loginPage={LoginPage}
- dashboard={Dashboard}
- theme={lightTheme}
- darkTheme={darkTheme || null}
- i18nProvider={i18nProvider}
- requireAuth
- {...rest}
+}: CRMProps) => {
+ useEffect(() => {
+ if (
+ disableTelemetry ||
+ process.env.NODE_ENV !== 'production' ||
+ typeof window === 'undefined' ||
+ typeof window.location === 'undefined' ||
+ typeof Image === 'undefined'
+ ) {
+ return;
+ }
+ const img = new Image();
+ img.src = `//https://o5drun0dw3.execute-api.eu-west-3.amazonaws.com/default/atomic-crm-telemetry?domain=${window.location.hostname}`;
+ }, [disableTelemetry]);
+
+ return (
+ <ConfigurationProvider
+ contactGender={contactGender}
+ companySectors={companySectors}
+ dealCategories={dealCategories}
+ dealPipelineStatuses={dealPipelineStatuses}
+ dealStages={dealStages}
+ logo={logo}
+ noteStatuses={noteStatuses}
+ taskTypes={taskTypes}
+ title={title}
>
- <CustomRoutes noLayout>
- <Route path={SignupPage.path} element={<SignupPage />} />
- <Route
- path={SetPasswordPage.path}
- element={<SetPasswordPage />}
- />
- <Route
- path={ForgotPasswordPage.path}
- element={<ForgotPasswordPage />}
- />
- </CustomRoutes>
+ <Admin
+ dataProvider={dataProvider}
+ authProvider={authProvider}
+ store={localStorageStore(undefined, 'CRM')}
+ layout={Layout}
+ loginPage={LoginPage}
+ dashboard={Dashboard}
+ theme={lightTheme}
+ darkTheme={darkTheme || null}
+ i18nProvider={i18nProvider}
+ requireAuth
+ disableTelemetry
+ {...rest}
+ >
+ <CustomRoutes noLayout>
+ <Route path={SignupPage.path} element={<SignupPage />} />
+ <Route
+ path={SetPasswordPage.path}
+ element={<SetPasswordPage />}
+ />
+ <Route
+ path={ForgotPasswordPage.path}
+ element={<ForgotPasswordPage />}
+ />
+ </CustomRoutes>
- <CustomRoutes>
- <Route path={SettingsPage.path} element={<SettingsPage />} />
- </CustomRoutes>
- <Resource name="deals" {...deals} />
- <Resource name="contacts" {...contacts} />
- <Resource name="companies" {...companies} />
- <Resource name="contactNotes" />
- <Resource name="dealNotes" />
- <Resource name="tasks" list={ListGuesser} />
- <Resource name="sales" {...sales} />
- <Resource name="tags" list={ListGuesser} />
- </Admin>
- </ConfigurationProvider>
-);
+ <CustomRoutes>
+ <Route
+ path={SettingsPage.path}
+ element={<SettingsPage />}
+ />
+ </CustomRoutes>
+ <Resource name="deals" {...deals} />
+ <Resource name="contacts" {...contacts} />
+ <Resource name="companies" {...companies} />
+ <Resource name="contactNotes" />
+ <Resource name="dealNotes" />
+ <Resource name="tasks" list={ListGuesser} />
+ <Resource name="sales" {...sales} />
+ <Resource name="tags" list={ListGuesser} />
+ </Admin>
+ </ConfigurationProvider>
+ );
+};