Skip to content

Latest commit

 

History

History
114 lines (83 loc) · 3.16 KB

README.md

File metadata and controls

114 lines (83 loc) · 3.16 KB

An open-source browser extension, that improves appearance of the St Andrews Student Resources, featuring a completely redesigned UI and UX, enhanced accessibility, and a range of new functionalities.

chrome web store mozilla addons

📂 Features

  • 🌙 Dark mode
  • ⬆️ improved accessibility
  • 🏷️ File icons
  • 🔍 Search and run commands with CTRL + K
  • 📌 Pinned links for easy access
  • 🖱️ Right-click to download files instantly
  • 🕰️ Minimal version tracking
  • 🚀 Smooth and fast navigation

⚛️ Tech Stack

  • vite
  • react
  • TypeScript
  • tailwind CSS
  • shadcn UI
  • tanstack query
  • nice-modal-react
  • react-syntax-highlighter

vite-web-extension template

🚀 Getting Started

📥 Local development setup

  1. clone the repo
git clone https://github.com/Herobread/better-studres-v2.git
  1. cd into directory
cd better-studres-v2/
  1. install dependencies
bun i
  1. Run in dev mode

Chrome:

bun run dev

Firefox:

bun run dev:firefox
  1. Add extension to the browser

chrome: https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked

firefox: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Your_first_WebExtension#installing

when you save file in dev mode, it will automatically rebuild the extension. After that you need to reload extension in browser and reload studres page to see changes.

🤝 Contributing

If you have an idea or found a bug, please open a GitHub Issue to suggest it.

Keep in mind that I'm trying to keep the extension as functional as possible, so some features might be rejected.

There are no official docs yet, but if you're feeling adventurous, you can try implementing the feature yourself!

📜 License

This project is licensed under the MIT License.

🌟 Support

If you find this project useful, consider giving it a ⭐ on GitHub!