https://github.com/danydodson/rivershub

🎶 RiversHub
https://github.com/danydodson/rivershub

Last synced: about 6 hours ago
JSON representation

🎶 RiversHub

• Host: GitHub
• URL: https://github.com/danydodson/rivershub
• Owner: danydodson
• Created: 2024-08-13T09:06:19.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-08-13T09:15:46.000Z (3 months ago)
• Last Synced: 2024-08-13T10:51:00.043Z (3 months ago)
• Language: JavaScript
• Size: 174 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# RiversHub



  



This is a Chrome extension that makes your GitHub profile into Weezer colors and maps your GitHub commit log into a playable audio soundtrack based off your GitHub contributions calendar!

# Requirements

- npm

- webpack

# How to build and run locally

To build, run the following command in terminal:

```

npm run build

```

While working on the project, dynamically save/update build of project using watch command:

```

npx webpack  --watch

```

Once you build the project, it will generate the relevant files to get this project working as a Chrome Extension.

You will need import the folder containing the project as a [developer chrome extension](https://bashvlas.com/blog/install-chrome-extension-in-developer-mode/) to get it working on chrome once you've built it using webpack.

This project will only show up on `github.com/*` pages that have a contribution calendar.

## Tutorials that were helpful

- [AWS: adding webpack to your project](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/webpack.html)

- [tone js step sequence](https://github.com/Tonejs/Tone.js/blob/dev/examples/stepSequencer.html)

- [Synthesizer example](https://tonejs.github.io/examples/stepSequencer)

- [Trav's Synthesizer Tutorial](https://blog.techsavvytravvy.com/make-a-synthesizer-with-tonejs)

- [How to see printout of chrome extension](https://stackoverflow.com/questions/3829150/google-chrome-extension-console-log-from-background-page)

- [MutationObserver](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver)