A full-featured CRM built with React, shadcn/ui, and Supabase.
[no ci] Doc fixes
fzaninotto1cf839c300e1
diff --git a/README.md b/README.mdindex 125c2721..1c7df354 100644--- a/README.md+++ b/README.md@@ -27,7 +27,7 @@ cd atomic-crmmake install```-This will install the dependencies for the frontend and the backend, including a local Supabase clone.+This will install the dependencies for the frontend and the backend, including a local Supabase instance.## Running the App In Development Mode@@ -39,7 +39,7 @@ make startThis will start the Vite dev server for the frontend, the local Supabase instance for the API, and a Postgres database (thanks to Docker).-You can then access the app via [`http://localhost:5173/`](http://localhost:5173/).+You can then access the app via [http://localhost:5173/](http://localhost:5173/).## Testing@@ -49,11 +49,11 @@ This project contains unit tests. Run them with the following command:make test```-## Deploying to production+## Deploying to Production### Supabase Configuration-To configure supabase, please have a look at [dedicated configuration guide](./doc/supabase-configuration.md).+To configure Supabase, please have a look at [dedicated configuration guide](./doc/supabase-configuration.md).### Testing Production Modediff --git a/doc/supabase-configuration.md b/doc/supabase-configuration.mdindex ac8fc144..3013154f 100644--- a/doc/supabase-configuration.md+++ b/doc/supabase-configuration.md@@ -1,54 +1,60 @@# Supabase Configuration-## Link Remote Instance Locally+### Creating a Remote Supabase Instance-Local remote instance link can be interesting if you want to deploy from your development computer or if you want your app with production data in production mode.+You can create a remote Supabase using the following script:-### Creating a new remote Supabase Instance--You can create a remote supabase using the following script:```shmake supabase-remote-init```-The script will prompt you for the project configuration and will apply migrations and deploy edge functions.+The script will ask you for the Supabase instance name, create the database, apply the migrations and deploy the edge functions. Finally, it will create a `.env.production.local` file with your remote Supabase configuration.+### Alternative: Using An Existing Supabase Instance-### Using An Existing Remote Supabase Instance+If you already created a Supabase instance for Atomic CRM, you can link the instance manually as follows.-If you already created the supabase instance, you can link the instance manually using the following commands:-First, log into your supabase account:+First, log into your Supabase account:```shnpx supabase login```-Now, link this project to the local supabase instance. You'll be asked to enter the database password.+Now, link this project to the local Supabase instance. You'll be asked to enter the database password.+```shnpx supabase link --project-ref ********************```Then, apply the migrations on it:+```shnpx supabase db pushnpx supabase functions deploy```-Finally, create the `.env.production.local` file with your supabase configuration:+Finally, add a `.env.production.local` file in the root directory with your remote Supabase credentials:```shVITE_SUPABASE_URL=<instance_url>VITE_SUPABASE_ANON_KEY=<instance_anon_token>```-This will allow your to use the linked supabase instance when running the following command to test the app in production mode locally:+## Testing Production Mode++Before deploying the frontend code to production, you should test the local frontend code when connected to the remote Supabase instance.++To do so, call the following command:+```shmake prod-start```+Using a remote Supabase instance can be interesting if you deploy from your computer, or if you want to test your app with production data in production mode.+## Continuous Integration and Continuous Delivery-This repository includes GitHub action worflow for Continuous Delivery. The configuration is explained in the [GitHub Actiosns guide](./github-actions.md) in the same directory.+This repository includes GitHub action workflow for Continuous Delivery. The configuration is explained in the [GitHub Actiosns guide](./github-actions.md) in the same directory.## Login Callback