CollabAI

About

Welcome to Collabai.software, where we've taken the world of AI to new heights. We've been working tirelessly to bring you the most advanced, user-friendly platform that seamlessly integrates with the powerful OpenAI API, Gemini, and Claude.

Imagine running your own ChatGPT on your server, with the ability to manage access for your entire team. Picture creating custom AI assistants that cater to your unique needs, and organizing your employees into groups for streamlined collaboration. With Collabai.software, this is not just a dream, but a reality.

Collabai.software Features:

Self-Hosting on Your Cloud: Gain full control by hosting the platform on your private cloud. Ensure data privacy by using your API codes, allowing for secure data handling.

Enhanced Team Management: Manage teams with private accounts and customizable access levels (Departments).

Prompt Templates: Utilize generic templates to streamline team usage.

Departmental Access & Assistant Assignment: Assign AI assistants to specific departments for shared team access.

Customizable AI Assistants: Create personalized AI assistants for users or organizations.

Tagging Feature in Chats: Organize and retrieve chat data efficiently with custom tags.

Chat Storage and Retrieval: Save all chats and replies for future analysis, with an option to restore accidentally deleted chats from Trash.

Optimized Performance: Experience our high-speed, efficient platform. Our clients have been using it for over a year, with some spending $1500-$2000 per month on the API.

File Upload & GPT-4 Vision Integration: Enhance interactions by uploading files for analysis and sending pictures for AI description.

OpenAI API, Gemini, and Claude Integration: Seamlessly integrate with the powerful OpenAI API, Gemini, and Claude for a comprehensive suite of AI capabilities.

API-Based Function Calls: Execute custom functions and automate tasks directly through the API.

Usage Monitoring: Track your daily and monthly API usage costs to optimize spending.

Day and Night Mode: Switch between light and dark themes to enhance visual comfort.

Additional Features:

Private Accounts: Ensure the security and privacy of your team members' data.

Customizable Access Levels: Tailor access permissions to meet the specific needs of your organization.

Shared Team Access: Foster collaboration by assigning AI assistants to specific departments or teams.

AI-Powered File Analysis: Gain insights and automate tasks by uploading files for AI analysis.

AI-Generated Image Descriptions: Enhance communication and understanding by sending pictures for AI-powered descriptions.

Folder Structure

1. Client

The client folder contains the React-based frontend code for the application. This includes JSX, CSS, and JavaScript files, as well as any additional assets such as images or fonts. Below is a brief overview of the main subdirectories within the client folder:

• src: This directory contains the React components, styles, and scripts for the frontend application.

• public: Static assets, such as images or favicon.ico, go here. This folder is served as-is and not processed by the build system.

2. Server

The server folder contains all the backend-related code for the application, following a Model-View-Controller (MVC) pattern. Here is a breakdown of the main subdirectories within the server folder:

• controllers: This directory holds the controller files responsible for handling requests, processing data, and interacting with models.

• models: Data models and database-related code are organized in this folder.

• config: Configuration files for the backend, such as database configuration or any other service configuration should be stored here, can be stored in this directory.

Getting Started

Follow the steps below to get the project up and running.

Prerequisites

• Node.js (Version: >=20.x)
• MongoDB
• NPM

Development

Setup

1. Clone the Repository

   copy

   https://github.com/sjinnovation/CollabAI.git
   
   
   

2. Navigate to the Client Folder

   copy

   cd client
   
   

3. Install Dependencies

   copy

   npm install
   
   

4. Navigate to the Server Folder

   copy

   cd ../server
   
   

5. Install Backend Dependencies

   copy

   npm install
   
   

6. Start Both Backend & Frontend Server

   copy

   npm start
   

To initialize the application data and create a superadmin user, you can use either cURL or Postman:

Using cURL

If you prefer command-line tools, you can use curl to make a POST request to the /init-setup endpoint. Open your terminal and run the following command:

   curl -X POST http://localhost:8011/api/init -H "Content-Type: application/json" -d '{
   "fname": "Super",
   "lname": "Admin",
   "email": "[email protected]",
   "password": "yourSecurePassword",
   "employeeCount": 100,
   "companyName": "INIT_COMPANY"
   }'

Initializing Setup with Postman

• Open Postman: Launch the Postman application.

• Create a New Request: Click on the '+' or 'New' button to create a new request.

• Set HTTP Method to POST: Ensure that the HTTP method is set to POST.

• Enter URL: Enter the URL http://localhost:8011/api/init.

• Set Headers:

  • Go to the 'Headers' tab.
  • Set Content-Type to application/json.

• Set Request Body:

  • Switch to the 'Body' tab.
  • Select the 'raw' radio button.
  • Enter the JSON data for your superadmin user:
  copy

  {
  "fname": "Super",
  "lname": "Admin",
  "email": "[email protected]",
  "password": "securePassword",
  "employeeCount": 100,
  "companyName": "INIT_COMPANY"
  }
  

• Send Request: Click the 'Send' button to make the request.

This will send a POST request to http://localhost:8011/api/init with the provided JSON payload, creating a superadmin user with the specified details.

• Site Setup: Login with the superadmin credentials and set up your site by adding configs from your settings page, for ex. API keys, etc.

Reference

CollaborativeAI Reference Guide

Contributing

If you would like to contribute to the project, we welcome your contributions! Please follow the guidelines outlined in the CONTRIBUTING.md file.

Feel free to raise issues, suggest new features, or send pull requests to help improve the project. Your involvement is greatly appreciated!

Thank you for contributing to our project!

License

MIT