Skip to content

Latest commit

 

History

History
190 lines (137 loc) · 6.99 KB

README.md

File metadata and controls

190 lines (137 loc) · 6.99 KB
Raw

Bot Verse 🚀

Bot Verse is an innovative platform for creating, sharing, and interacting with AI chatbots. Users can manage their own chatbots, explore public and system chatbots, and leverage pre-made solutions for various tasks. This project is open source and welcomes contributions from the community.

Forks Issues Open Pull Requests Close Pull Requests

Table of Contents

Features 🌟

  • Authentication 🔐: Secure sign-up, login, and logout functionality.
  • CRUD for Chatbots ✍️: Create, update, delete, and manage your chatbots effortlessly.
  • Public Chatbots 🌍: Share your chatbots with the community and discover others' creations.
  • System Chatbots 🛠️: Use pre-made chatbots for common tasks and questions.
  • Search Functionality 🔍: Easily filter chatbots by name or description in the dashboard.
  • Dark/Light Mode Toggle 🌗: Switch between light and dark themes using a toggle button, with preferences saved using localStorage.

Tech Stack 🛠️

Python Flask SQLAlchemy SQLite Tailwind CSS GROQ HTML5

Open Source Programs

VSOC Logo GSSOC 2024
This project is part of GirlScript Summer of Code Extd. We welcome contributions from the community.

🚀 Repo Activity

Repobeats analytics image

Ready to Contribute?

Kindly go through CONTRIBUTING.md to understand everything from setup to contributing guidelines and must follow Code of Conduct

If you would like to contribute to the project, please follow our contribution guidelines.

For more detailed development instructions, refer to DEVELOPMENT.md.

Installation ⚙️

To set up and run Bot Verse locally, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/kom-senapati/bot-verse.git
cd bot-verse

  2. Create a Virtual Environment:

    python -m venv .venv

  3. Activate the Virtual Environment:

    • On Windows:

      source .venv/Scripts/activate

    • On macOS/Linux:

      source .venv/bin/activate

  4. Install Dependencies:

    pip install -r requirements.txt

  5. Set Up the Environment Variables:

    Create a .env file in the root directory of the project and add the required environment variables:

    GROQ_API_KEY=your_groq_api_key

  6. Initialize the Database:

    flask db init

  7. Apply Database Migrations:

    flask db migrate -m "Initial migration"
flask db upgrade

  8. Setup tailwind for styling (Only if any UI changes).

Download Tailwind CLI from official releases page. Make sure you download that accounding to your os. Keep that executor in folder inside the project /tailwind. And rename downloaded file to tailwindcss.

  1. Only for linux give execution permissions.

    chmod +x tailwind/tailwindcss

  2. Run the Python Script to generate styles

    python build_css.py --watch

  3. Run the Application:

    python run.py

    The application will be available at http://127.0.0.1:5000.

Tip from us 😇

It always takes time to understand and learn. So, don't worry at all. We know you have got this! 💪

Show Your Support

If you find this project interesting and inspiring, please consider showing your support by starring it on GitHub! Your star goes a long way in helping us to reach more developers and encourages to keep enhancing the project.

Memo License

Bot Verse is licensed under the MIT License. See the LICENSE file for more information.

I love connecting with different people, so if you want to say hi, I'll be happy to meet you more! :)
Welcome to our community—join our Discord.