/screenrecorder-chrome-extension-backend

Primary LanguagePython

Chrome Extension Backend

This contains the backend code for a screenrecorder chrome extension plugin, which provides a RESTful API for managing video retrieval, saving to disk, and transcription.

Installation

To run the Chrome Extension Backend locally, follow these steps:

  1. Clone the Repository and Activate the Virtual Environment:

    git clone https://github.com/iamprecieee/screenrecorder-chrome-extension-backend.git
cd chrome
python3 -m venv venv   # Creates a virtual environment
source venv/bin/activate  # Activates the virtual environment (Windows users: use venv\Scripts\activate)

  2. Install Required Dependencies:

    pip install -r requirements.txt

  3. Setup Configuration:

    • Create a config.py file and configure the necessary environment variables, such as upload details, swagger API config, max file content length, and other configuration settings.

  4. Run the App:

    flask run # OR `python3 app.py`

Structure

  • Init - This creates and configures the Flask application.
  • Config - This handles the configuration variables for the entire app.
  • Database - This initailises, creates, and defines methods for operation on the database.
  • Models - This contains the SQLAlchemy model for the videos.
  • Utils - This module contains all necessary helper functions for views.py
  • Views - This contains the endpoints necessary for operations on recorded video files.
  • App - This handles application running with necessary variables set in flaskenv.

Documentation

For detailed documentation on the API endpoints and their usage, please refer to the following:

Swagger UI and Live Link