How to Install CollabAI

Complete installation guide and setup instructions to get CollabAI running on your system

Download Source Code

Prerequisites

Before installing CollabAI, ensure you have the following installed on your system:

Node.js (Version: >=20.x)
PostgreSQL (via Supabase) - Database for storing application data
NPM - Node Package Manager

Installation Steps

Follow these steps to set up CollabAI on your local machine:

1. Clone the Repository

git clone https://github.com/sjinnovation/CollaborativeAI.git

2. Navigate to Client Folder

cd client

3. Install Frontend Dependencies

npm install

4. Navigate to Server Folder

cd ../server

5. Install Backend Dependencies

npm install

6. Start the Application

npm start

Initial Setup & Configuration

Initialize the application with a superadmin user and configure your settings

Using cURL:

curl -X POST http://localhost:8011/api/init \
-H "Content-Type: application/json" \
-d '{
  "fname": "Super",
  "lname": "Admin",
  "email": "superadmin@example.com",
  "password": "yourSecurePassword",
  "employeeCount": 100,
  "companyName": "INIT_COMPANY"
}'

Using Postman:

Open Postman and create a new POST request
Set URL to: http://localhost:8011/api/init
Set Content-Type header to: application/json
Add the JSON payload in the request body
Send the request to create your superadmin user

Next Step: Login with your superadmin credentials and configure your site settings, including API keys and other configurations from the settings page.

Getting Started Video

Watch our installation walkthrough to see the process in action

Need Help?

If you encounter any issues during installation, here are some resources to help you:

Contribution Guidelines Contact Support