Installing ChatSuite CRM

Learn how to install ChatSuite CRM on your local machine

This guide will help you set up the ChatSuite CRM application on your local machine. ChatSuite CRM is a multi-tenant customer relationship management platform with WhatsApp automation capabilities.

Requirements

To get started with the ChatSuite CRM application, ensure you have the following software installed:

  • Node.js 22.x or higher
  • Git
  • Docker (for local Supabase instance)

Getting Started with ChatSuite CRM

Clone the repository

To get the codebase on your local machine, clone the repository with the following command:

git clone git@github.com:antoineschaller/chatsuite.git
cd chatsuite

The CRM application is located in the apps/crm-saas directory:

cd apps/crm-saas

Installing the Node dependencies

Install the NodeJS dependencies with npm from the project root:

cd ../..  # Back to project root
npm install

Setting up Environment Variables

The application requires environment variables for Supabase, authentication, and Stripe. Run the following command to sync secrets from 1Password:

npm run secrets:sync

Alternatively, create a .env.local file in the apps/crm-saas directory with the required environment variables. See .env.template for reference.

Setting up Supabase

The application uses Supabase for authentication and database. You can either:

  1. Use local Supabase (recommended for development):

    npm run supabase:start
    
  2. Connect to remote Supabase: Update your .env.local with your Supabase project credentials.

Running the Application

Start the development server:

npm run dev:crm

The application will be available at http://localhost:3001.

Default Credentials

For local development, use the following test account:

  • Email: test@chatsuite.akson.ch
  • Password: TestPassword123!

You can also create a new account through the signup page.

Next Steps

Now that your application is running, you can:

  1. Set up your Supabase project (see Supabase setup guide)
  2. Configure authentication providers
  3. Set up Stripe for subscriptions
  4. Explore the dashboard and session management features

So let's jump on to the next step!