Skip to content
triton11Public

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

AI Lesson Generator

An AI-powered lesson planning tool built with Vue 3, AWS Amplify, and OpenAI. Create custom lesson plans with AI assistance using flexible templates and scaffolds.

This was an early prototype I built of the platform that eventually became CoTeach.ai. We got extensive feedback from teachers on the UI and general approach (a tool for building tools) that pushed us in a different direction, but it was fun experimenting with the WYSIWG editor and other fun features like "remix" and template sharing!

Create: Build your own AI-powered lesson template using a WYSIWYG toolkit including instructions, variable inputs, and outputs (lists, four square and more)!

Screenshot 2025-11-28 at 12 25 48 PM

Browse: Browse your own templates or shared templates to find lessons for your class!

Screenshot 2025-11-28 at 12 41 13 PM

Generate: Use your lesson template to generate a lesson for your class using AI!

Screenshot 2025-11-28 at 12 28 49 PM

Remix: Make your own changes to existing lesson templates to use in the future!

Screenshot 2025-11-28 at 12 36 04 PM

Features

  • 🤖 AI-powered lesson generation using OpenAI
  • 📝 Customizable lesson templates
  • 🎨 Multiple scaffold types (Four Square, Grid, Quiz, Vocab List, etc.)
  • 📚 Standards-aligned (ELA and Math standards included)
  • 👤 User authentication via AWS Cognito
  • 💾 Lesson saving and management
  • 🖨️ Print-friendly lesson output

Prerequisites

  • Node.js (v18 or higher)
  • AWS Account (for Amplify backend)
  • OpenAI API Key (users provide their own)

This template should help get you started developing with Vue 3 in Vite.

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Customize configuration

See Vite Configuration Reference.

Project Setup

1. Install Dependencies

npm install

2. Configure AWS Amplify Backend

This project uses AWS Amplify for authentication and data storage. You'll need to set up your own AWS backend:

# Install Amplify CLI globally
npm install -g @aws-amplify/cli

# Configure Amplify with your AWS credentials
amplify configure

# Initialize Amplify in the project
amplify init

# Push the backend configuration to AWS
amplify push

After running amplify push, Amplify will generate a src/aws-exports.js file with your backend configuration. This file is gitignored for security.

For detailed setup instructions, see:

3. OpenAI API Key

Users will be prompted to enter their own OpenAI API key when they first use the application. The key is stored locally in browser cookies and is never sent to your backend.

4. Run Development Server

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint

Security Notes

⚠️ Important: This repository does not include AWS credentials or API keys.

  • AWS configuration files (aws-exports.js, team-provider-info.json) are gitignored
  • Users provide their own OpenAI API keys through the application UI
  • Never commit .env files or files containing secrets

Resources

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages