Skip to content

Latest commit

 

History

History
84 lines (61 loc) · 2.11 KB

README.md

File metadata and controls

84 lines (61 loc) · 2.11 KB

THIS PROJECT IS NOT WORKED ON AND NOT ON THE STORE ANYMORE SINCE GOOGLE RELEASED THEIR ASK FEATURE

Textframe

This monorepo contains a Python FastAPI backend and a Chrome Extension frontend that work together to find specific moments in YouTube videos based on spoken content (transcript).

📂 Project Structure

This repository consists of two main components:

🚀 Quick Start

Setup

  1. Clone the repository:
git clone https://github.com/aumb/textframe.git
cd textframe
  1. Set up the textframe API:
cd textframe-api
pip install -r requirements.txt
  1. Set up the textframe Extension:
cd textframe-extension
npm install

🔗 Component Documentation

🏗️ Architecture

textframe/
├── textframe-api/      # Backend service
│   ├── app/            # Source code
│   └── requirements.txt
└── textframe-extension/    # Frontend extension
    ├── src/             # Source code
    └── manifest.json

Building for Production

# Build API
cd textframe-api
docker build -t textframe-api .
docker run -d -p 80:80 textframe-api

# Build Extension
cd textframe-extension
npm run pack

📄 License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License - see the LICENSE file for details.

This means you can:

  • ✅ Use the code for personal projects
  • ✅ Modify and distribute the code
  • ✅ Use it for educational purposes
  • ❌ Use it for commercial purposes
  • ❌ Monetize it directly or indirectly

If you'd like to use this project for commercial purposes, please contact the maintainers for a different licensing arrangement.

👥 Maintainers