Skip to content

Installation

From web stores

The extension is available on Firefox Add-ons, and is currently awaiting approval for the Chrome Web Store.

Firefox Add-ons

INFO

Schooltape is currently unavailable in the following web stores:

  • Chrome Web Store
  • Edge Add-ons
  • Opera Add-ons
  • Safari Extensions

Please install Schooltape from GitHub releases or source code.

From GitHub releases

Please follow the instructions for your browser:

From source

WARNING

Installing from source is not recommended for most users.

  1. Clone the repository:

    sh
    cd path/to/where/you/want/schooltape/to/be
    git clone https://github.com/schooltape/schooltape.git
    cd schooltape
  2. Install Bun

    bash
    curl -fsSL https://bun.sh/install | bash
    bash
    curl -fsSL https://bun.sh/install | bash
    powershell
    powershell -c "irm bun.sh/install.ps1 | iex"
  3. Install dependencies

    bash
    bun install
  4. Build the extension

    bash
    bun build
    bash
    bun build:firefox
  5. Load the extension:

    • For Chrome / Chromium-based:

      1. Open chrome://extensions/.
      2. Enable Developer mode.
      3. Click on Load unpacked.
      4. Select the dist directory in the schooltape directory.
    • For Firefox:

      1. Open about:debugging#/runtime/this-firefox.
      2. Click on Load Temporary Add-on.
      3. Select the manifest.json file in the dist directory in the schooltape directory.

TIP

You can also use bun dev or bun dev:firefox to build the extension in development mode, which will automatically reload the extension when you make changes. More information can be found in the contributing guide.

WARNING

Loading a temporary add-on in Firefox will remove the extension when you close the browser.

Released under the GPL-3.0 license.