Callgent API

Please, help our community project. Star on GitHub! Exciting News (November, 2024): Discover what is new in Callgent here!

Callgent API is an open-source SaaS project built using NestJS, Prisma, PostgreSQL, and Swagger. It is licensed under the Apache-2.0 License.

Table of Contents

• Callgent API
  • Table of Contents
  • Introduction
  • Features
  • Prerequisites
  • Installation
  • Configuration
  • Running the Application
    • Running from docker-compose
  • API Documentation
  • Testing
  • Contributing
  • License

Introduction

Callgent API is a powerful, scalable, and extensible platform designed to help developers create, manage, and deploy bots across various channels. It provides a robust set of features, enabling seamless integration with popular messaging platforms and services.

Features

• User authentication and authorization
• Bot creation and management
• Channel integration (Slack, Facebook Messenger, Telegram, etc.)
• Webhook management
• Conversation history and analytics
• Extensible plugin architecture

Prerequisites

Before you start using Callgent API, ensure you have the following tools installed:

• Node.js (>= 18.0.0)
• npm (>= 6.0.0)
• PostgreSQL (>= 10.0.0)
• Docker (optional, for local development)

Installation

1. Clone the repository:

   git clone https://github.com/Callgent/callgent-api.git
   cd callgent-api

2. Install the dependencies:

   pnpm install

Configuration

Create a .env file in the project root directory based on the .env.dev file provided. Update the configuration values according to your environment.

Running the Application

1. Run the Prisma migration to set up the database schema:

   npx prisma migrate deploy

2. Start the application:

   npm run start:dev

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

Running from docker-compose

1. Run the following command from project root, to start the containers:

   docker-compose up -d

2. Initialize the database:

   cp .env.dev .env
   echo 'DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@localhost:${POSTGRES_PORT}/${POSTGRES_DB}?schema=public&timezone=UTC' >> .env
   npx prisma db seed

3. Initialize the test data (optional):

   pnpm run prisma:seed-test

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

API Documentation

Swagger documentation is available at http://localhost:3000/docs/docs/api.

Testing

To run the tests, use the following command:

npm run test

Contributing

We welcome contributions from the community! Before submitting a pull request, please review our Contributor Development Agreement (CDO).

License

Callgent.com is licensed under the Apache-2.0 License. See the LICENSE file for more information.

---

For more information, please visit our documentation or join our community.