MOSA-Fall-Hackathon-2024

Lessonly

Overview

Project Summary

Lessonly is a virtual lesson planner for teachers. It features a calendar-based interface where educators can add daily notes, integrate AI-generated lesson plans, and track existing lessons for multiple grade levels. This tool is meant to help teachers save time and centralize teaching resources into one application

Authors

• Faris Karim – FarisKarim – farisk@seas.upenn.edu – github.com/FarisKarim

Usage

Prerequisites

Ensure you have the following installed:

Node.js

Install the latest version of Node.js :

# On Ubuntu/Debian
curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -
sudo apt-get install -y nodejs

# On macOS (using Homebrew)
brew install node

Python 3.x and pip

Install Python and pip (Python package manager):

# On Ubuntu/Debian
sudo apt update
sudo apt install python3 python3-pip

# On macOS (using Homebrew)
brew install python

Installation

Clone the repository

git clone https://github.com/FarisKarim/teachingassistant.git
cd teachingassistant

Backend Setup

Navigate to the backend directory:

cd backend

Populate environment variables:

• Create a .env file in the backend directory.
• Add the following variables:

OPENAI_API_KEY=your_openai_api_key

Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate 

Install dependencies once you activate the venv:

pip install -r requirements.txt

Run the application:

uvicorn main:app --reload

To stop the server:

CTRL + C

To deactivate the venv run:

deactivate

Client Setup

Navigate to the frontend directory:

cd frontend
cd clientui

Install dependencies:

npm install

Run the application:

npm run dev

Note: Only need to do npm install the first time to install dependencies.

Deployment

Run locally

# Start the backend
uvicorn main:app --reload

# In another terminal, start the frontend
npm run dev

Once both are running, open your browser and go to http://localhost:5173

Additional Information

Tools Used

• Vite & Tailwind CSS
• Node.js
• Python & FastAPI
• OpenAI API

Resources Used

• FastAPI Docs
• Tailwind CSS Docs
• React, Vite Docs
• Stack Overflow

Demo

Click for demo