Skip to content

A free and open source web extension to customise the look, feel, and functionality of Schoolbox!

License

Notifications You must be signed in to change notification settings

schooltape/schooltape

Repository files navigation

Logo
Schooltape

Schooltape is a free an open source extension for Schoolbox!

Discord Logo GitHub Logo

Join our community!

Previews

🌻 Latte
🪴 Frappé
🌺 Macchiato
🌿 Mocha

Features

  • Schoolbox detection: Automatic detection of any Schoolbox instance!
  • Plugins: Built with a plugin system in mind, allowing for easy extensibility.
  • Themes: Save your eyes from the harsh white of Schoolbox.
  • Snippets: Schooltape has a growing ecosystem of snippets, allowing for easy CSS modifications.

Wiki

There is more information on the website!

Usage

The extension is available on the Chrome Web Store and the Firefox Add-ons extension store. Click on your browser's badge below to install.

Manually

git clone https://github.com/schooltape/schooltape.git
cd schooltape
bun install

Chrome

  1. Run bun build.
  2. Open the Extensions page by navigating to chrome://extensions.
  3. Enable Developer Mode by flipping the toggle switch labelled Developer mode.
  4. Click the Load unpacked button and select the dist/chrome-mv3 directory from the cloned repository.

Firefox

  1. Run bun zip:firefox.
  2. Open the Add-ons page by navigating to about:addons.
  3. Click the cog/settings icon in line with the "Manage Your Extensions" heading, and select Debug Add-ons.
  4. Click the Load Temporary Add-on... button and select the dist/schooltape-<version>-firefox.zip file from the cloned repository.

Development

Setup

git clone https://github.com/schooltape/schooltape.git
cd schooltape
bun install

Usage

To launch a browser instance with the extension loaded and a Schoolbox page already opened, run bun dev for Chrome or bun dev:firefox for Firefox.

To build the extension, run either:

  • bun build, where the compiled extension will be available at dist/chrome-mv3...
  • or bun zip:firefox, where the compiled and zipped extension can be found at dist/schooltape-<version>-firefox.zip.

Publishing

The bun wxt submit init command will walk you through each of the tokens that needs to be added for publishing to each store.

💝 Thanks to