Skip to content
/ Nix Public

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/Nix

Repository files navigation

Nix

Adaptive Explanation Engine for Complex Topics

React Vite Tailwind CSS Groq


Nix is a next-generation study companion that uses advanced AI to break down complex concepts into understandable explanations. Whether you're a curious 5-year-old or a PhD researcher, Nix adapts its language and depth to suit your needs.


✨ Features

Feature Description
🧠 Adaptive AI Powered by the Groq API (Llama 3 / Mixtral) for instant, high-quality insights.
🎚️ 5 Complexity Levels From "Child" (simple analogies) to "Expert" (rigorous math & theory).
πŸ—ΊοΈ Learning Paths Instantly generate logical, 5-step roadmaps to master any complex topic.
πŸƒ 1-Click Flashcards Automatically extract core concepts into interactive 3D-flippable study cards.
πŸ•’ Smart History Automatically saves your sessions locally. Access past explanations via the sidebar.
πŸ“„ Pro PDF Export Generate professional, branded PDFs of your notes with LaTeX math and formatting preserved.
🎨 Obsidian UI A beautiful, distraction-free dark mode interface using Tailwind CSS and Vercel-inspired design.
πŸ“± Mobile Ready Fully responsive design with touch-friendly controls and stackable layouts.
οΏ½ Rich Rendering Supports Markdown tables, Code blocks (with syntax highlighting), and LaTeX equations ($E=mc^2$).

πŸŽ›οΈ How It Works

Nix isn't just a chatbot; it's a tuned engine. Select a level to change how the AI thinks:

  1. οΏ½ Child: Uses magic, stories, and simple words.
  2. 😊 Simple: Everyday examples for a general audience.
  3. πŸ“š Detailed: Structured breakdown with "What, Why, How".
  4. πŸŽ“ Academic: Undergraduate-level rigor with definitions.
  5. οΏ½ Expert: Edge cases, advanced theory, and LaTeX derivations.

πŸ› οΈ Tech Stack

  • Frontend: React + Vite
  • Styling: Tailwind CSS + Typography Plugin
  • Markdown: react-markdown, remark-math, rehype-katex, react-syntax-highlighter
  • Export: jspdf + html2canvas for high-fidelity PDF generation
  • AI: Groq SDK (openai/gpt-oss-120b compatible endpoint)

πŸš€ Getting Started

Prerequisites

Installation

  1. Clone the repo

    git clone https://github.com/Dsp023/Nix.git
    cd Nix
  2. Install dependencies

    npm install
  3. Configure Environment Create a .env file in the root directory:

    VITE_GROQ_API_KEY=gsk_your_actual_api_key_here
  4. Run Locally

    npm run dev

    Open http://localhost:5173 to start learning!


οΏ½ Project Structure

src/
β”œβ”€β”€ components/
β”‚   └── ExplainEngine.jsx  # Main application logic & UI
β”œβ”€β”€ utils/
β”‚   └── pdfGenerator.js    # PDF export utility
β”œβ”€β”€ index.css              # Global styles & Tailwind directives
β”œβ”€β”€ App.jsx                # Root layout
└── main.jsx               # Entry point

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Created by Nakka Devi Sri Prasad

GitHub

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