Clone the ChatSuite Repository
Learn how to clone the ChatSuite repository and install the NodeJS dependencies.
This guide will walk you through cloning the ChatSuite repository and installing the necessary dependencies to get started with local development.
Requirements
To get started with ChatSuite, ensure you have the following software installed:
- Node.js 22.x or later
- Git
- Docker (for local Supabase)
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
Navigate to Dashboard Application
The dashboard is located in the apps/dashboard directory:
cd apps/dashboard
Installing the Node dependencies
Install the NodeJS dependencies with npm from the project root:
cd ../.. # Back to project root
npm install
This will install dependencies for all applications in the monorepo.
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/dashboard directory
with the required environment variables. See .env.template for reference.
Next Steps
Now that you have the repository cloned and dependencies installed, you can:
- Set up your Supabase project (see Supabase setup guide)
- Start the development server
- Begin exploring the codebase
Let's jump on to the next step!