Skip to content

SwiftDust/studymate

Repository files navigation

StudyMate

Need a little help with studying? Always get distracted way too easily? StudyMate's got you covered.

Proudly powered ⚡ by WXT Logo WXT and Svelte Logo Svelte.

Made with ❤️ for Hack Club the Game (QoL improvements and new features from original High Seas ship)

Features

Currently, the app is in development. Right now, there's a cute little pixel art pomodoro timer with the features to switch from timer and track the amount of finished timers.

Coming soon 👀: User settings, an option to block websites, a logo (of course!) a parrot which randomly blurts out motivational quotes(?) -- enough reason to stay tuned!

Demo video

A few screenshots

StudyMate Dark Mode StudyMate Light Mode

Development

  1. Make sure you have npm and pnpm.
  2. Install dependencies with pnpm i.
  3. Run development server with pnpm run dev.

Installing

If you're a developer, you can zip the extension with pnpm zip. If you have no idea what that means, please continue.

Installing through a ZIP file

  1. At the "releases" tab, there's a ZIP file for every new StudyMate release. Choose Firefox or Chrome dependent on which browser you use.
  2. (Chrome only) Unzip the file.
    • (Chrome) Click on the three dots ansd click on Extensions. Next, click on Manage extensions.
    • (Firefox) Click on the three horizontal lines and click on Add-ons and themes. Then, in the left sidebar, click on "extensions".
    • (Chrome) Switch the slider on that says Developer Mode.
    • (Firefox) Click on the cog wheel. Click "Debug Add-ons".
    • (Chrome) Click on "Load unpacked extension". Then, click on your unzipped folder.
    • (Firefox) Click on "Load temporary extension". Then, click on your ZIP file.

Enjoy! Please note that on Firefox, the extension is only temporary since it isn't signed yet. When you really want to start using it, you have to download it from their store.

Installing from the store

This isn't yet possible, sorry.

Acknowledgements

About

Your personal study timer (ADHD friendly)

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors