Skip to content

utkarshsingh77/eduapp

Repository files navigation

EduForge: AI Lesson & Quiz Builder

A modern web application that helps teachers, coaches, and therapists create standards-aligned lesson plans, activities, and assessments in under 2 minutes.

Features

  • AI-Powered Generation: Create comprehensive lesson plans with a single click
  • Standards Alignment: Supports Common Core, NGSS, NCSS, CASEL, and custom standards
  • Multiple Educator Types: Designed for teachers, coaches, and therapists
  • Interactive Activities: Generate hands-on learning experiences
  • Assessment Tools: Create quizzes with multiple question types
  • Export Options: Export to Google Forms, LMS systems, or download as JSON

Project Structure

eduapp/
├── index.html              # Main HTML file
├── styles/
│   └── main.css           # All CSS styles
├── js/
│   └── app.js             # All JavaScript functionality
└── README.md              # This file

Getting Started

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn
  • OpenAI API key (Get one here)

Installation

  1. Clone the repository (or download the files)

    git clone <repository-url>
    cd eduapp
  2. Install dependencies

    npm install
  3. Configure OpenAI API key

    • Copy .env.example to .env
    • Replace your_openai_api_key_here with your actual OpenAI API key
    cp .env.example .env
    # Edit .env and add your API key
  4. Start the development server

    npm run dev

    The application will open automatically in your browser at http://localhost:3000

Production Build

To build for production:

npm run build

The built files will be in the dist directory.

Using the Application

  1. Input Section:

    • Topic: Enter your subject or learning objective
    • Educator Type: Choose your role (Teacher, Coach, Therapist)
    • Grade Level: Select appropriate age group
    • Duration: Choose lesson length
    • Standards: Pick relevant standards framework (optional for coaches and therapists)
    • Quick Options: Select additional features like differentiation or interactivity
    • Constraints: Add any specific requirements
  2. Output Section:

    • Lesson Plan: Complete, standards-aligned lesson structure
    • Activities: Engaging, hands-on learning experiences
    • Quiz: Assessment questions in various formats

Export Options

  • Google Forms: Export quiz to Google Forms format
  • LMS Export: Download in QTI format for Canvas/Blackboard/Moodle
  • Print All: Print-friendly version of all materials
  • JSON Download: Download all data for external processing

Technical Details

  • Vite: Modern build tool for fast development and optimized production builds
  • OpenAI API Integration: Real AI-powered content generation using GPT-4
  • ES Modules: Modern JavaScript module system
  • Responsive Design: Works on desktop, tablet, and mobile devices
  • Modern CSS: Uses CSS Grid, Flexbox, and CSS Custom Properties
  • Async/Await: Clean asynchronous code for API calls

Browser Support

  • Chrome 60+
  • Firefox 55+
  • Safari 12+
  • Edge 79+

Development

To modify the application:

  1. Styling: Edit styles/main.css for visual changes
  2. Core Functionality: Modify js/app.js for behavior changes
  3. AI Integration: Update js/openai-service.js for AI generation logic
  4. Structure: Update index.html for layout changes
  5. Configuration: Update vite.config.js for build settings

Available Scripts

  • npm run dev - Start development server with hot reload
  • npm run build - Build for production
  • npm run preview - Preview production build locally

Environment Variables

The app uses the following environment variables:

  • VITE_OPENAI_API_KEY - Your OpenAI API key (required)
  • VITE_OPENAI_ORG_ID - Your OpenAI organization ID (optional)

Future Enhancements

  • User accounts and lesson plan saving in the cloud
  • Backend API to secure API keys and add rate limiting
  • Collaborative features for team lesson planning
  • Additional export formats (PDF, Word, PowerPoint)
  • Template library for common lesson types
  • Support for multiple AI models (Claude, Gemini, etc.)
  • Offline mode with cached content
  • Multi-language support

License

This project is open source and available under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published