AbacatePay AI Assistant

A chatbot assistant designed to help users with AbacatePay-related queries and tasks.

Project Overview

This project consists of two main components:

Running as Monorepo

This project is configured as a monorepo using npm workspaces. You can run both frontend and backend from the root directory.

Quick Start (Monorepo)

1. Install all dependencies for both workspaces:

npm install

2. Run the frontend in development mode:

npm run dev:frontend

3. Run the backend in development mode:

npm run dev:backend

Available Monorepo Scripts

From the root directory, you can use these scripts:

• npm run build:frontend - Build the frontend
• npm run start:frontend - Start the frontend in production mode
• npm run dev:frontend - Start the frontend in development mode
• npm run build:backend - Build the backend
• npm run start:backend - Start the backend in production mode
• npm run dev:backend - Start the backend in development mode

Frontend (abacate-chat)

A web front-end built using NextJS.

[LEGACY] How to run it

1. Update the env file to point to your API

cd abacate-chat
npm install
npm run dev

Backend (abacate-chat-api)

An small API to communicate with Itzam for AI interactions

[LEGACY] How to run it

1. Update the env file with an ITZAM API KEY
2. You might need to add prompts and knowledge to Itzam, they can be found on abacate-chat-api/contexts.

cd abacate-chat-api
npm install
npm run dev

Project Links

• UI/UX Designs

Contributing

We welcome contributions from the community! Here's how you can contribute:

1. Find an Issue

   • Browse through our Issues page
   • Look for issues tagged with good-first-issue or something you want to help with
   • Comment on the issue you'd like to work on

2. Fork and Clone

• Fork the repo using github
• Clone and make your changes

git clone https://github.com/AbacatePay/abacate-chat.git
cd abacate-chat
git checkout -b feature/your-feature-name

3. Make Changes

   • Write clean, documented code
   • Follow the existing code style
   • Add tests when applicable

4. Create a Pull Request

   • Push your changes to your fork
   • Create a PR against the main branch
   • Include in your PR description:
     • What changes you made
     • Why you made these changes
     • How you tested the changes
     • Screenshots/logs showing the changes working
     • Any related issue numbers

5. Code Review

   • Wait for maintainers to review your PR
   • Make any requested changes
   • Once approved, your PR will be merged

License

This project is licensed under the MIT License - see the LICENSE file for details.