BetterSEQTA-Plus/README.md

A beautiful 🤩 Chrome Extension that adds additional features and gives an overall better experience for SEQTA Learn. Currently looking for contributors 🔥

Table of contents

• Features
• Getting Started

Release Videos

Features

• Dark mode
  • Custom Background/Themes
• Improved Styling/CSS
  • Improved look for SEQTA Learn
• Custom Home Page including:
  • Daily Lessons
  • Shortcuts
  • Easier Access Notices
  • Assessments
• Options to remove certain items from the side menu
• Fully customisable themes and an offical theme store
• Notification for next lesson (sent 5 minutes before end of the lesson)
• Browser Support
  • Chrome Supported
  • Edge Supported
  • Brave Supported
  • Opera Supported
  • Vivaldi Supported
  • Firefox (Experimental - available here)
  • Safari (Experimental - only available via compilation)

Getting started

1. Clone the repository

git clone https://github.com/BetterSEQTA/BetterSEQTA-Plus

Running Development

1. Install dependencies

npm install # or your preferred package manager like pnpm or yarn

2. Run the dev script (it updates as you save files)

npm run dev

3. Load the extension into chrome

• Go to chrome://extensions
• Enable developer mode
• Click Load unpacked
• Select the dist folder

Just remember, in order to update changes to the extension, you need to click the refresh button on the extension in chrome://extensions whenever anything's changed.

Building for production

1. Install dependencies

npm install # or your preferred package manager like pnpm or yarn

2. Run the build script

npm run build

3. Package it up (optional)

npm run package # This requires 7-Zip to be installed in order to work

Folder Structure

The folder structure is as follows:

• The src folder contains source files that are compiled to the build directory.

• The src/interface folder contains source React files that are required for the Settings page.

• The dist folder is where the compiled code ends up, this is the folder what you need to load into chrome as an unpacked extension for development.

• The safari folder is an Xcode project, building it for MacOS does work, IOS needs a few modifications to the manifest to work, but I have managed to get it working. It will give an error, to fix this you need to regenerate it, you can delete the safari folder and then run the command xcrun safari-web-extension-converter <extension-folder>/dist and it will automatically generate the xcode project where you are.

Contributors

Want to contribute? Click Here!

Credits

This extension was initially developed by Nulkem, was ported to manifest V3 by MEGA-Dawg68 and is currently under active development by SethBurkart123 and Crazypersonalph

Star History