Broucher is a chatbot built with Next.js, Firebase, and Python that understands natural language, providing product information, website guidance, and project management features.
Tech Stack:
- Frontend: Next.js
- Backend: Firebase Firestore, Cloud Functions
- Chatbot Engine: Python (look into the
notebook
folder for more info)
Features:
- Natural Language Product Inquiry: Ask questions about products and receive detailed descriptions, specifications, and answers.
- Website Task Guidance: Get step-by-step instructions for completing tasks on your website.
- Project Management: Add and manage projects, raise issues, and track progress directly through the chatbot.
- Web UI: View all added projects and raised issues in a clean web interface.
Setting Up the Project:
- Clone the repository:
git clone git@github.com:your-username/broucher.git
- Install dependencies:
npm install
oryarn install
- Set up your Firebase project and configure necessary environment variables.
- Run the development server:
npm run dev
oryarn dev
- Train the chatbot engine according to chosen framework's instructions.
- Setup the chatbot engine on your server and set the API link in the frontend.
Contributing:
We welcome contributions! Please follow these guidelines:
- Fork the repository and create a new branch for your changes.
- Write clear and concise commit messages.
- Submit pull requests for review and discussion.
- Adhere to the project's style guide and coding standards.
License:
This project is licensed under the MIT License. See the LICENSE
file for details.