Skip to content

RaymondWHZ/ai-office-hour

Repository files navigation

🪄 AI Office Hour

An AI-powered tutoring assistant that helps students understand academic problems through interactive conversation and live document editing. Instead of simply providing answers, AI Office Hour acts as a patient mentor, guiding students to discover solutions through thoughtful questions and annotations.

Tech Stack

Prerequisites

Getting Started

1. Clone the repository

Standard HTTP method:

git clone https://github.com/tailwindlabs/tailwindcss-typography.git
cd ai-office-hour

You may also use SSH or GitHub CLI methods for this step instead.

2. Install dependencies

bun install

3. Set up environment variables

Create a .env file in the root directory:

OPENAI_API_KEY=your_api_key_here
CLAUDE_API_KEY=your_api_key_here

4. Start the development server

bun run dev

Open http://localhost:5173 in your browser.

Available Custom Commands

All commands are run from the root of the project:

Command Action
bun run dev Start local dev server at localhost:4321
bun run build Build production site to ./dist/
bun run preview Preview production build locally
bun run check:format Check if code is properly formatted
bun run check:type Run TypeScript type checking
bun run lint Run oxlint to check code quality
bun run check Run format check, lint, and type check together
bun run format Format code with Prettier

Deployment

This project is still under development and not tested for deployment yet.

About

🚧 In Progress: AI-Powered General Purpose Academic Tutor

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors