Skip to content

FrostByte-49/StellarLearn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 

Repository files navigation

💫 StellarLearn – Your Cosmic Learning Companion

StellarLearn isn’t just another learning tool, it’s an interstellar journey where education becomes an immersive, cosmic adventure. Every lesson propels you deeper into a universe of knowledge, every concept becomes a new galaxy to explore, and every achievement lights up your personal constellation of progress. With a breathtaking space-themed interface and an engaging gamified structure, learning feels less like a task and more like an odyssey through the stars.

Powered by React 18, TypeScript, Tailwind CSS, and advanced AI models from OpenAI, StellarLearn merges futuristic design with intelligent personalization to create an experience that’s both inspiring and transformative. This platform doesn’t simply deliver information, it captivates, challenges, and elevates learners to new dimensions of understanding. Your voyage into the cosmos of knowledge begins now.


📚 Table Of Contents


✨ Features

  • Cosmic Dashboard with interactive learning map
  • Mission Quests with structured learning paths
  • LearnHub – Upload PDFs/YouTube videos to generate smart notes & questions
  • AI Mentor (Pixie) – Real-time learning assistance and explanations
  • Interactive Flashcards for effective revision
  • Achievements System with cosmic-themed badges
  • Personalized Settings with profile management
  • Fully Responsive monochromatic cosmic design
  • Glassmorphism UI with smooth animations

📸 Preview

Home Page Dashboard Page
Home Page Dashboard
Mission Quests Page LearnHub Page
Mission Quests LearnHub
AI Mentor Page Flashcards Page
AI Mentor Flashcards
Achievements Page Settings Page
Achievements Settings

📁 Project Structure

StellarLearn/
└── 📁StellarLearn_
    ├── 📁backend/
    │   ├── server.js                   # Express.js API Server
    │   ├── package.json                # Backend Dependencies
    │   └── .env                        # Environment Variables
    │
    ├── 📁public/
    │   ├── 📁data/                    # Static Application Data
    │   │   ├── achievements.json
    │   │   ├── flashcards.json
    │   │   └── quests.json
    │   │
    │   ├── 📁images/                  # Application Assets
    │   │   ├── Picture_1-8.webp
    │   │   └── Pixie.jpg
    │   │
    │   └── _redirects                 # Netlify Routing
    │
    ├── 📁src/
    │   ├── 📁components/             # Reusable UI Components
    │   │   ├── Sidebar.tsx            # Navigation Sidebar
    │   │   └── Logo.tsx               # Application Logo
    │   │
    │   ├── 📁pages/                  # Application Pages
    │   │   ├── Dashboard.tsx          # Main Dashboard
    │   │   ├── LearnHub.tsx           # Content Processing Hub
    │   │   ├── Mentor.tsx             # AI Mentor Interface
    │   │   ├── Quests.tsx             # Mission Quests
    │   │   ├── Flashcards.tsx         # Study Flashcards
    │   │   ├── Achievements.tsx       # Progress Tracking
    │   │   ├── Settings.tsx           # User Preferences
    │   │   └── Landing.tsx            # Welcome Page
    │   │
    │   ├── App.tsx                   # Main Application Component
    │   ├── main.tsx                  # Application Entry Point
    │   └── vite-env.d.ts             # TypeScript Definitions
    │
    ├── package.json                  # Frontend Dependencies
    ├── tailwind.config.js            # Tailwind CSS Configuration
    ├── vite.config.ts                # Vite Build Configuration
    └── tsconfig.json                 # TypeScript Configuration

⚙️ Technologies Used

Technology Purpose
React 18 + TypeScript Component-based UI with type safety
Vite Fast development build tool
Tailwind CSS Utility-first CSS framework
Express.js Backend API server
OpenAI API AI-powered content generation
Lucide React Beautiful icons
Netlify/Render Production deployment

🚀 Getting Started

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn
  • OpenAI API key

Installation

  1. Clone the repository
git clone https://github.com/FrostByte-49/StellarLearn.git
cd StellarLearn/StellarLearn_
  1. Install dependencies
# Frontend dependencies
npm install

# Backend dependencies
cd backend
npm install
cd ..
  1. Environment Setup
# Backend .env file (backend/.env)
OPENAI_API_KEY=your_openai_api_key_here
  1. Start development servers
# Terminal 1 - Backend (runs on http://localhost:5000)
cd backend
npm run dev

# Terminal 2 - Frontend (runs on http://localhost:5173)
npm run dev
  1. Open your browser Navigate to http://localhost:5173 to see StellarLearn in action!

🧪 Usage Guide

  1. 🏠 Start at Dashboard – View your cosmic learning journey
  2. 📚 Visit LearnHub – Upload PDFs or YouTube links to generate study materials
  3. 🤖 Chat with Pixie – Get AI-powered learning assistance in Mentor section
  4. 🎯 Complete Quests – Engage with structured learning missions
  5. 📇 Study with Flashcards – Use interactive cards for revision
  6. 🏆 Track Progress – Monitor achievements and learning stats
  7. ⚙️ Customize Experience – Adjust settings in your profile

🎯 Core Features

🌌 LearnHub – Smart Content Processing

  • PDF Upload: Extract and generate structured notes from documents
  • YouTube Integration: Process video transcripts into study materials
  • AI-Powered Generation: Automatic note formatting and practice questions
  • Export Functionality: Download generated content for offline study

🤖 AI Mentor (Pixie)

  • Real-time Assistance: Instant answers to learning questions
  • Concept Explanations: Step-by-step breakdowns of complex topics
  • Personalized Guidance: Adaptive learning support
  • Quick Prompts: Pre-built templates for common queries

🚀 Mission Quests

  • Structured Learning Paths: Guided educational journeys
  • Progressive Difficulty: Gradually challenging content
  • Achievement Tracking: Cosmic badges and rewards
  • Learning Analytics: Visual progress monitoring

🌈 Customization

Adding New Learning Categories

  1. Update public/data/quests.json with new mission structures
  2. Add corresponding achievement badges in public/data/achievements.json
  3. Extend the cosmic map in Dashboard.tsx

Theming

  • Modify tailwind.config.js for color scheme changes
  • Update glassmorphism effects in component CSS
  • Customize cosmic background gradients

AI Prompt Engineering

  • Enhance content generation by modifying prompts in backend/server.js
  • Customize response formatting for different learning styles

🛠️ Future Enhancements

  • Spaced Repetition for flashcards
  • Collaborative Learning features
  • Mobile App version
  • Advanced Analytics dashboard
  • Multi-language Support
  • Voice Interactions with AI mentor
  • Gamification Elements – leaderboards, challenges
  • Integration with popular learning platforms

🤝 Contributing

We welcome contributions to make StellarLearn even more stellar!

How To Contribute

  1. Fork the repository
  2. Create a feature branch
git checkout -b feature/amazing-feature
  1. Commit your changes
git commit -m "✨ Add: Amazing feature"
  1. Push to the branch
git push origin feature/amazing-feature
  1. Open a Pull Request

Areas For Contribution

  • 🎨 UI/UX improvements and animations
  • 🔧 Backend API enhancements
  • 📚 New learning content and quests
  • 🧪 Testing and bug fixes
  • 📖 Documentation improvements
  • 🌐 Internationalization

📄 License

This Project is licensed under the MIT License. Feel free to explore and build upon it.
© 2025 Pranav Khalate

Permission Is Hereby Granted, Free Of Charge, To Any Person Obtaining A Copy...

🙌 Credits

  • OpenAI – Powering intelligent content generation and AI mentorship
  • Lucide – Beautiful, consistent iconography
  • Tailwind CSS – Utility-first CSS framework
  • Vite – Fast build tool and development server
  • React & TypeScript – Modern web development foundation

📢 Author

Created with ❤️ by the StellarLearn Team

Website GitHub   LinkedIn   Email   Discord


🌟 Support The Project

If you find StellarLearn helpful in your learning journey, please consider giving it a ⭐️ on GitHub – it helps others discover this cosmic learning experience!

At StellarLearn, We're Not Just Lighting Fires, We're Igniting Supernovas Of Curiosity & Knowledge That Will Illuminate Your Path To Mastery!

Ready To Embark on Your Cosmic Learning Journey? The Stars Await Your Curiosity!



💫 "The Universe Is Full Of Magical Things Patiently Waiting For Our Wits To Grow Sharper."

    – Eden Phillpotts

About

A Gamified, AI-Powered Cosmic Learning Platform That Transforms Education Into An Immersive Interstellar Journey

Resources

License

Stars

2 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors