Skip to content

AI-powered learning tool that simplifies complex topics with customizable explanations for all ages and expertise levels. πŸ“š

Notifications You must be signed in to change notification settings

Dsp023/Explainit-to-me

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ The "Explain It To Me" Engine

React Vite Tailwind CSS Groq

An intelligent web application that transforms complex text into simple, easy-to-understand explanations using the power of AI. Built with React, Vite, and Tailwind CSS, and powered by the Groq API for lightning-fast responses.


✨ Features

  • πŸ€– AI-Powered Explanations: Leverages the Groq API to provide high-quality explanations for any text you provide.
  • 🎚️ Adjustable Complexity: Choose from five different explanation levels, from a simple explanation for a child to an expert-level breakdown.
  • 🎨 Sleek & Modern UI: A beautiful and responsive interface built with Tailwind CSS, providing a great user experience.
  • ⚑ Blazing Fast: Built with Vite for a rapid development experience and optimized performance.
  • πŸ“₯ Export & Clear: Easily clear the text and explanation, or export the generated explanation to a .txt file.
  • πŸ”’ Secure API Key Handling: Uses environment variables to keep your API keys safe and secure.

πŸ› οΈ Tech Stack


πŸš€ Getting Started

Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Installation

  1. Clone the repository:

    git clone https://github.com/Dsp023/Explain-It-To-Me.git
    cd Explain-It-To-Me
  2. Install NPM packages:

    npm install
  3. Set up your environment variables: Create a .env file in the root of your project and add your Groq API key:

    VITE_GROQ_API_KEY=YOUR_API_KEY_HERE

    You can get a free API key from Groq.

  4. Run the development server:

    npm run dev

    The application will be available at http://localhost:5173 (or the next available port).


πŸ“– Usage

  1. Paste the text you want to be explained into the "Your Text" text area.
  2. Use the slider to select your desired level of explanation.
  3. Click the "Explain" button.
  4. The explanation will appear in the "Explanation" section below.
  5. Use the "Clear" button to reset the fields or the "Export" button to save the explanation as a text file.

πŸ‘€ Author

Nakka Devi Sri Prasad


About

AI-powered learning tool that simplifies complex topics with customizable explanations for all ages and expertise levels. πŸ“š

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published