jgchk / better-rym

Enhancements for RateYourMusic 🎧
GNU General Public License v3.0
52 stars 7 forks source link

BetterRYM

Enhancements for RateYourMusic 🎧

Download

Features

Contributing

I take any and all PRs. So far I've worked with a few talented developers and would love to work with more:

Issues are also always welcome. This is the best way to get my attention on a bug or feature request.

Dev Environment

Setup

  1. Install yarn
  2. Create a .env file at the project root with the following format:
SPOTIFY_ID=<client id>
SPOTIFY_SECRET=<client secret>
YOUTUBE_KEY=<api key>
DISCOGS_KEY=<key>
DISCOGS_SECRET=<secret>
  1. Create a Spotify client ID/secret, YouTube API key, and a Discogs application and place them in the .env file.

Dev Server

BetterRYM includes a dev server which will hot-reload your browser automatically as you work. It passes source maps and unminified code to the browser for easier debugging.

# Install dependencies
yarn

# Start dev server
yarn dev

Load the unpacked extension from ./output into your browser (Chrome, Firefox)

Production

Use this to generate a production build with minified code.

# Install dependencies
yarn

# Build for all browsers
yarn prod

# Build for individual browsers
yarn prod:chrome
yarn prod:firefox

License

GPL-3.0