Skip to content

Cyvid7-Darus10/financial-discord-bot

Repository files navigation

Discord Bot Connected with Plaid and Chat GPT

This bot, built using TypeScript, not only facilitates engaging interactions via OpenAI's GPT-4 model within our Discord server but also integrates with Plaid for advanced financial functionalities.

🌟 Features

  • OpenAI Integration: Leverage the advanced capabilities of OpenAI's GPT-4 model to engage and interact with users on our Discord server.

  • Plaid Integration: Our bot intelligently integrates with Plaid to offer financial insights, fetch transactions, check account balances, and more, all driven by user input.

  • Intelligent API Decisions: Through the integration of OpenAI, our bot is able to derive what Plaid API should be called based on the nuances of user input. It ensures relevant responses and actions are made to fit user inquiries.

  • TypeScript Powered: Experience enhanced type safety leading to robust code and a superior developer experience.

  • Scalable Architecture: Our bot is designed with the future in mind. Expand and add more features with ease as our needs evolve.

  • Permission System: Introducing a versatile permission system! Now, create commands that are only accessible based on custom permissions you set.

  • Developer Exclusive Commands: Restrict certain commands to the developer team. With our new feature, you can design commands exclusively for developers.

  • Disable Commands: Easily disable any command to prevent its usage, offering you greater control over the bot's functionalities.

🚀 Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js (v14 or higher is recommended)
  • TypeScript (v4 or higher is recommended)

Setup & Installation

Follow the steps below to get the bot up and running:

  1. Clone the Repository:

    git clone git@github.com:Summary-Box/discord-bot-cp.git
  2. Navigate to the Project Directory:

    cd discord-bot
  3. Install Dependencies:

    npm install
  4. Compile the TypeScript Code:

    npm run build
  5. Start the Bot:

    npm start

For development purposes, use:

npm run dev

This command watches for any changes in TypeScript files and restarts the bot automatically.

Testing

Maintain high code quality and functionality by running tests:

npm test

📦 Packages & Libraries

We've integrated some of the best libraries and packages to enhance our bot's functionality:

  • discord.js: For seamless Discord API interactions.
  • openai: Official OpenAI Node.js client.
  • plaid: A powerful library for interacting with the Plaid financial API.
  • dotenv: Efficiently manage environment variables.
  • jest & ts-jest: Essential testing utilities for our codebase.
  • tsc-watch: Enhanced TypeScript compilation.
  • prettier: Keeping our code clean and formatted.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published