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:
- Textframe API - Backend REST API service
- Textframe Extension - Frontend browser extension
š Quick Start
Setup
- Clone the repository:
git clone https://github.com/aumb/textframe.git
cd textframe
- Set up the textframe API:
cd textframe-api
pip install -r requirements.txt
- 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.