Skip to content

ossd-s25/Meowtivation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

54 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Meowtivation – A Purr-fect Study Companion!

Meowtivation is an open-source MIT-licensed browser extension designed to provide motivation to students studying by allowing them to simply click on the extension and be greeted with an inspiration cat gif.

Installation

Follow this simple guide to get the extension set up:

(1) Download the code

Clone our repository to your computer:

$git clone https://github.com/ossd-s25/Meowtivation.git

(2) Set up the API key

Due to the open-source nature of our project, we can't offer a single API key for all of our users :(. Therefore, we need you to spend a minute to make your own API key to Giphy (our cat GIF database).

Here's how you do it:

First, go to the Giphy developer site and create an account.

Once you have an account, go to the Giphy dashbaord and click "Create an API Key"

Then, select "SDK" and click "Next Step":

Next, enter some information about the app. Here is an example of the type of information to add:

Now you should have an API key! Please copy it, and paste it into the apiKey variable in popup.js right here

(3) Load the extension

Now we need to load the extension into Chrome!

First, go to the "Manage Extensions" section in Chrome. Once there, make sure that "Developer Mode" is turned on. You'll find the "Developer Mode" button on the top-right of the page. Once you are in the developer mode, go to the top left of the page and click "Load Unpacked extension". Then, select the src folder in this repository and load it.

And that's it! You're all set to study with a motivational cat. Feel free to pin the extension for the best experience.

How to Contribute

Contributions are welcome! If you have a suggestion or an issue, please use the issue tracker to let me know.

Read more about contributing to Meowtivation in CONTRIBUTING.md.

License

Meowtivation is licensed under the MIT License.

Contributors

Discussion Board

Please feel free to comment and create discussions in our github discussion board!

About

Meowtivation is an open-source browser extension designed to keep students motivated while studying! Simply click on the extension, and be greeted with an inspiring cat GIF to brighten your day.

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors