Skip to content

aryan6673/eduai

πŸŽ“ EduAI Platform

The fastest path from prompt to production with Gemini AI

MIT License React TypeScript Vite Google AI

An AI-powered educational platform that revolutionizes learning with intelligent tutoring, adaptive pathways, and seamless course management.

✨ Features

πŸš€ For Students

  • AI-Adaptive Pathways - Personalized learning routes that adapt in real-time
  • 24/7 AI Voice Tutor - Get instant help with voice-powered AI assistance
  • Interactive Courses - Engaging content with multimedia materials
  • Real-time Discussions - Collaborate with peers and instructors
  • Project Workspaces - Manage assignments and group projects
  • Career Center - Industry-recognized micro-credentials and career guidance

πŸ‘¨β€πŸ« For Teachers

  • AI Lesson Planner - Generate complete lesson plans in seconds
  • Predictive Analytics - Identify at-risk students before they struggle
  • Automated Feedback - Provide rich, constructive feedback instantly
  • Course Management - Streamlined content creation and organization
  • Student Analytics - Track progress and engagement metrics

🏫 For Administrators

  • User Management - Comprehensive admin dashboard
  • Course Analytics - Institution-wide insights and reporting
  • Resource Management - Efficient allocation of educational resources

πŸš€ Quick Start

Prerequisites

  • Node.js (16.0 or higher)
  • npm or yarn
  • Google AI API Key (Get one here)

Installation

  1. Clone the repository

    git clone https://github.com/aryan6673/eduai.git
    cd eduai
  2. Install dependencies

    npm install --legacy-peer-deps
  3. Set up environment variables

    Create a .env.local file in the root directory:

    GEMINI_API_KEY=your_gemini_api_key_here
  4. Run the development server

    npm run dev
  5. Open your browser

    Navigate to http://localhost:5173 to see the application.

🌐 Deploy to Vercel

Deploy your EduAI platform to Vercel with one click:

Deploy with Vercel

Manual Deployment

  1. Install Vercel CLI

    npm i -g vercel
  2. Login to Vercel

    vercel login
  3. Deploy

    vercel --prod
  4. Set Environment Variables

    In your Vercel dashboard, add your environment variables:

    • GEMINI_API_KEY: Your Google AI API key

Environment Variables for Vercel

Make sure to set these environment variables in your Vercel project settings:

Variable Description Required
GEMINI_API_KEY Google AI Gemini API key βœ…

πŸ› οΈ Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run proxy - Start development proxy server

πŸ—οΈ Project Structure

eduai/
β”œβ”€β”€ components/           # React components
β”‚   β”œβ”€β”€ dashboard/       # Dashboard components
β”‚   β”œβ”€β”€ course/          # Course-related components
β”‚   β”œβ”€β”€ common/          # Reusable UI components
β”‚   └── layout/          # Layout components
β”œβ”€β”€ data/                # Mock data and types
β”œβ”€β”€ services/            # API services and Firebase
β”œβ”€β”€ types/               # TypeScript type definitions
β”œβ”€β”€ contexts/            # React contexts
└── server/              # Server and proxy configuration

🎯 Technologies Used

  • Frontend: React 19, TypeScript, Vite
  • Styling: Tailwind CSS
  • AI Integration: Google Gemini AI
  • Backend: Firebase
  • Charts: Recharts
  • Icons: Lucide React
  • Deployment: Vercel

πŸ“± Google AI Studio Integration

This platform is built with Google AI Studio and leverages the power of Gemini AI for:

  • Intelligent content generation
  • Personalized learning recommendations
  • Automated grading and feedback
  • Voice-powered tutoring

View the app in AI Studio: https://ai.studio/apps/drive/1q-igWHA-0OlMrtfKyPXP0552WQZfrMME

🀝 Contributing

We welcome contributions from the community! Please see our Contributing Guidelines for more details.

  1. Fork the repository
  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

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ‘₯ Contributors

This project is brought to you by:

πŸ™ Acknowledgments

  • Google AI Studio team for the amazing Gemini AI integration
  • The open-source community for the incredible tools and libraries
  • All contributors who help make this project better

πŸ“ž Support

If you encounter any issues or have questions:

  1. Check the Issues page
  2. Create a new issue if your problem isn't already listed
  3. Join our community discussions

Built with ❀️ by @aryan6673

Empowering education through AI innovation

About

an AI-powered platform for students and teachers to enable personalized learning and smart course management.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors