Skip to content

moashraf86/GroqBot

Repository files navigation

GroqBot

GroqBot is a modern chat application that leverages the Groq API to provide dynamic and interactive chat functionalities. It allows users to engage in conversations, choose chat models, adjust tones, and manage preferences seamlessly.

Features

  • Chat Functionality: Engage in real-time conversations with the bot.
  • Model Selection: Choose from different chat models provided by the Groq API.
  • Tone Adjustment: Adjust the tone of responses to fit different contexts.
  • User Preferences: Customize and save user preferences for a personalized experience.
  • Markdown Rendering: Use react-md-editor to render markdown content in chat messages.
  • Responsive Design: Accessible and functional on various devices.

Technologies Used

  • React: For building the user interface and managing state.
  • Shadcn UI: For enhanced UI components.
  • Tailwind CSS: For styling and responsive design.
  • react-md-editor: For rendering markdown content in chat messages.
  • Groq API: For chat functionalities and model interactions.

Installation

To set up and run GroqBot locally, follow these steps:

  1. Clone the Repository

    git clone https://github.com/moashraf86/GroqBot.git
    cd GroqBot
  2. Install Dependencies

    Make sure you have Node.js installed. Then, run:

    npm install
  3. Configure Environment Variables

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

    REACT_APP_GROQ_API_KEY=your_groq_api_key
  4. Run the Development Server

    Start the development server with:

    npm run dev

    The app will be available at http://localhost:3000.

Contributing

Contributions are welcome! If you have any ideas or improvements, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with descriptive messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request to the main repository.

Contact

For any questions or issues, please reach out to [email protected].

About

AI-powered Chat App

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published