mirror of
https://github.com/BetterSEQTA/BetterSEQTA-Plus.git
synced 2026-06-05 19:24:39 +00:00
Jones
127 lines
7.0 KiB
Markdown
127 lines
7.0 KiB
Markdown
<a href="https://chromewebstore.google.com/detail/betterseqta+/afdgaoaclhkhemfkkkonemoapeinchel">
|
|
<img src="https://socialify.git.ci/betterseqta/betterseqta-plus/image?description=1&font=Inter&forks=1&issues=1&logo=data%3Aimage%2Fsvg%2Bxml%2C%253Csvg%20height%3D%27656pt%27%20fill%3D%27white%27%20preserveAspectRatio%3D%27xMidYMid%20meet%27%20viewBox%3D%270%200%20658%20656%27%20width%3D%27658pt%27%20xmlns%3D%27http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%27%253E%253Cg%20transform%3D%27matrix(.1%200%200%20-.1%200%20656)%27%253E%253Cpath%20d%3D%27m2960%206499c-918-100-1726-561-2278-1299-196-262-374-609-475-925-171-533-203-1109-91-1655%20228-1115%201030-2032%202104-2408%20356-124%20680-177%201080-176%20269%201%20403%2014%20650%2064%20790%20159%201503%20624%201980%201290%20714%20998%20799%202342%20217%203420-488%20902-1361%201515-2382%201671-113%2017-196%2022-430%2024-159%202-328-1-375-6zm566-1443c476-99%20885-385%201134-791%20190-309%20282-696%20250-1045-22-240-73-420-180-635-78-156-159-275-274-401l-77-84h445%20446v-235-236l-1162%204-1163%203-100%2023c-449%20101-812%20337-1071%20697-77%20107-193%20335-233%20459-115%20358-116%20726-1%201078%20209%20644%20766%201101%201446%201187%20128%2016%20405%204%20540-24z%27%2F%253E%253Cpath%20d%3D%27m3065%204604c-250-36-396-89-576-209-280-187-470-478-535-821-25-135-16-395%2019-525%2095-351%20331-644%20651-806%2098-49%20225-93%20331-114%2092-18%20368-18%20460%200%20481%2095%20853%20444%20982%20921%2035%20129%2044%20389%2019%20524-36%20191-121%20387-228%20531-186%20249-476%20428-783%20485-65%2012-291%2021-340%2014z%27%2F%253E%253C%2Fg%253E%253C%2Fsvg%253E&name=1&owner=1&pattern=Signal&stargazers=1&theme=Dark" />
|
|
</a>
|
|
|
|
<p align="center">
|
|
A beautiful 🤩 Chrome Extension that adds additional features and gives an overall better experience for <a href="https://educationhorizons.com/solutions/seqta/">SEQTA Learn.</a> <strong>Currently looking for contributors</strong> 🔥
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a target="_blank" href="https://chrome.google.com/webstore/detail/betterseqta%20/afdgaoaclhkhemfkkkonemoapeinchel"><img src="https://user-images.githubusercontent.com/95666457/149519713-159d7ef7-2c21-4034-a616-f037ff46d9a4.png" alt="ChromeDownload" width="250"></a>
|
|
<a target="_blank" href="https://discord.gg/YzmbnCDkat"><img src="https://github.com/SethBurkart123/EvenBetterSEQTA/assets/108050083/23055730-b16e-44c0-9bef-221d8545af92" width="240" style="border-radius:10%;" /></a>
|
|
</p>
|
|
|
|
<div>
|
|
<img src="https://img.shields.io/chrome-web-store/users/afdgaoaclhkhemfkkkonemoapeinchel" />
|
|
<img src="https://img.shields.io/chrome-web-store/rating/afdgaoaclhkhemfkkkonemoapeinchel" />
|
|
</div>
|
|
|
|
## Table of contents
|
|
|
|
- [Features](#features)
|
|
- [Creating Custom Themes](#creating-custom-themes)
|
|
- [Getting Started](#getting-started)
|
|
- [Running Development](#running-development)
|
|
- [Building for production](#building-for-production)
|
|
- [Folder Structure](#folder-structure)
|
|
- [Contributors](#contributors)
|
|
- [Credits](#credits)
|
|
- [Star History](#star-history)
|
|
|
|
## 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
|
|
- Grades calculator
|
|
- Fully customisable themes and an official theme store
|
|
- Notification for next lesson (sent 5 minutes before end of the lesson)
|
|
- Browser Support
|
|
- Chrome, Edge, Brave, Opera and other Chromium-Based browsers are supported
|
|
- Firefox Supported: [here](https://addons.mozilla.org/en-US/firefox/addon/betterseqta-plus/)!
|
|
- Safari (Experimental and not recommended - only available via compilation)
|
|
|
|
## Creating Custom Themes
|
|
|
|
If you are looking to create custom themes, I would recommend you start at the official documentation [here](https://betterseqta.gitbook.io/betterseqta-docs). You can see some premade examples along with a compilation script that can be used to allow for CSS frameworks and libraries such as SCSS to be used [here](https://github.com/BetterSEQTA/BetterSEQTA-Theme-Generator).
|
|
|
|
Don't worry- if you get stuck feel free to ask around in the [discord](https://discord.gg/YzmbnCDkat). We're open and happy to help out! Happy creating :)
|
|
|
|
## 🚀 Want to Contribute?
|
|
|
|
**New contributors welcome!** 🎉 We've made it easy to get started:
|
|
|
|
- **👋 New to the project?** Start with our [Getting Started Guide](./docs/GETTING_STARTED_CONTRIBUTING.md)
|
|
- **🏗️ Want to understand the code?** Check out our [Architecture Guide](./docs/ARCHITECTURE.md)
|
|
- **🧩 Interested in plugins?** Read our [Plugin Development Guide](./docs/plugins/README.md)
|
|
- **🐛 Found a bug?** Open an [issue](https://github.com/BetterSEQTA/BetterSEQTA-plus/issues) or fix it yourself!
|
|
- **💬 Need help?** Join our [Discord community](https://discord.gg/YzmbnCDkat)
|
|
|
|
We have lots of https://github.com/BetterSEQTA/BetterSEQTA-Plus/labels/good%20first%20issue labels perfect for beginners!
|
|
|
|
## Quick Development Setup
|
|
|
|
**1. Fork & Clone**
|
|
```bash
|
|
git clone https://github.com/YOUR_USERNAME/BetterSEQTA-Plus
|
|
cd BetterSEQTA-Plus
|
|
```
|
|
|
|
**2. Install & Run**
|
|
```bash
|
|
npm install --legacy-peer-deps
|
|
npm run dev
|
|
```
|
|
|
|
**3. Load in Browser**
|
|
1. Go to `chrome://extensions`
|
|
2. Enable "Developer mode"
|
|
3. Click "Load unpacked" → Select `dist` folder
|
|
4. Visit a SEQTA page to see it work! 🎉
|
|
> [!WARNING]
|
|
> Whenever you update the extension while not in dev mode, you will need to use the reload button on the extension page.
|
|
|
|
📚 **Need more details?** Check our [detailed setup guide](./docs/GETTING_STARTED_CONTRIBUTING.md#your-first-30-minutes)
|
|
|
|
### Building for Production
|
|
|
|
```bash
|
|
npm run build # Build for all browsers
|
|
npm run zip # Package for distribution (requires 7-Zip)
|
|
```
|
|
|
|
## Folder Structure
|
|
|
|
The folder structure is as follows:
|
|
|
|
- The `src` folder contains source files that are compiled to the build directory.
|
|
|
|
- The `src/plugins` folder contains vital loaders required for BetterSEQTA+ functionality.
|
|
|
|
- The `src/interface` folder contains source React & Svelte 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.
|
|
|
|
## Contributors
|
|
|
|
<a href="https://github.com/betterseqta/betterseqta-plus/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=betterseqta/betterseqta-plus" />
|
|
</a>
|
|
|
|
Want to contribute? [Click Here!](https://github.com/BetterSEQTA/BetterSEQTA-Plus/blob/main/CONTRIBUTING.md)
|
|
|
|
## Credits
|
|
|
|
This extension was initially developed by [Nulkem](https://github.com/Nulkem/betterseqta), was ported to manifest V3 by [MEGA-Dawg68](https://github.com/MEGA-Dawg68) and is currently under active development from lead developers [SethBurkart123](https://github.com/SethBurkart123) and [Crazypersonalph](https://github.com/Crazypersonalph) with help from other volunteers.
|
|
|
|
## Star History
|
|
|
|
[](https://star-history.com/#BetterSEQTA/BetterSEQTA-Plus&Date)
|