A chatbot assistant designed to help users with AbacatePay-related queries and tasks.
This project consists of two main components:
This project is configured as a monorepo using npm workspaces. You can run both frontend and backend from the root directory.
- Install all dependencies for both workspaces:
npm install- Run the frontend in development mode:
npm run dev:frontend- Run the backend in development mode:
npm run dev:backendFrom the root directory, you can use these scripts:
npm run build:frontend- Build the frontendnpm run start:frontend- Start the frontend in production modenpm run dev:frontend- Start the frontend in development modenpm run build:backend- Build the backendnpm run start:backend- Start the backend in production modenpm run dev:backend- Start the backend in development mode
A web front-end built using NextJS.
- Update the env file to point to your API
cd abacate-chat
npm install
npm run devAn small API to communicate with Itzam for AI interactions
- Update the env file with an
ITZAM API KEY - 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 devWe welcome contributions from the community! Here's how you can contribute:
-
Find an Issue
- Browse through our Issues page
- Look for issues tagged with
good-first-issueor something you want to help with - Comment on the issue you'd like to work on
-
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-
Make Changes
- Write clean, documented code
- Follow the existing code style
- Add tests when applicable
-
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
-
Code Review
- Wait for maintainers to review your PR
- Make any requested changes
- Once approved, your PR will be merged
This project is licensed under the MIT License - see the LICENSE file for details.