https://github.com/djdembeck/mirmir

A Ruby on Rails tool designed to seed MusicBrainz track relationships with rich API data from Jaxsta, contributing to improved music data quality.
https://github.com/djdembeck/mirmir

api data-seeding jaxsta music music-data musicbrainz rails ruby ruby-on-rails

Last synced: 6 days ago
JSON representation

A Ruby on Rails tool designed to seed MusicBrainz track relationships with rich API data from Jaxsta, contributing to improved music data quality.

• Host: GitHub
• URL: https://github.com/djdembeck/mirmir
• Owner: djdembeck
• License: gpl-3.0
• Created: 2021-06-30T16:42:14.000Z (over 3 years ago)
• Default Branch: develop
• Last Pushed: 2023-12-15T05:22:28.000Z (11 months ago)
• Last Synced: 2023-12-15T06:36:40.557Z (11 months ago)
• Topics: api, data-seeding, jaxsta, music, music-data, musicbrainz, rails, ruby, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 222 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Mirmir

[![GitHub](https://img.shields.io/github/license/djdembeck/mirmir)](https://github.com/djdembeck/mirmir/blob/develop/LICENSE)

[![Docker](https://github.com/djdembeck/mirmir/actions/workflows/docker-publish.yml/badge.svg)](https://github.com/djdembeck/mirmir/actions/workflows/docker-publish.yml)

[![CodeFactor](https://www.codefactor.io/repository/github/djdembeck/mirmir/badge)](https://www.codefactor.io/repository/github/djdembeck/mirmir)

A tool written in Ruby on Rails, to seed MusicBrainz track relationships with data from Jaxsta track credits.

NOTE: Currently, this is only a data display tool, until I can determine the best course of action for seeding MB either through API, scraping or automation tools.

## Purpose

The goal here is to make rich track-level credits easy to add to MusicBrainz, which is the upstream metadata source of many online music services. What the final product of seeding this data looks like can be seen here:

https://musicbrainz.org/release/eecba6f1-67dc-45d6-942d-15e329d7886e

But doing a release like that, can take *hours*. As such, this project aims to simplify the process by:

- Clearly displaying relevant data, and nothing else

- Presenting a format in which the data is easy to copy for manual data entry.

- In the future, seeding this data into the appropriate fields, and only requiring the user to verify data accuracy.

## Running

Eventually, I intend to deploy this as a web service. Until it is stable enough to do so, you can run this locally in one of two ways:

### Docker (recommended):

Since Docker is the quickest way to get up and running without worrying about requirements and dependencies, it's the recommended way to get started.

    docker run --rm -d --name mirmir -p 3000:3000/tcp ghcr.io/djdembeck/mirmir:main

- Open a browser to `127.0.0.1:3000`

### Webserver:

#### Requirements

- Ruby 3.0.0 or later

- Rails 6.1.4 or later

A great guide on setting up the requirements for setup, can be found here: https://gorails.com/setup/ubuntu/21.04#overview

#### Setup

Getting up and running is pretty straightforward. From the project directory:

- `gem install bundler`

- `bundle install`

- `rails s -b 127.0.0.1`

- Open a browser to `127.0.0.1:3000`

## Running tests

After setting up the dependencies above, tests can be run from the project folder with:

    bundle exec rspec

## Notes

Tidal/Spotify methods are also written but not exposed (Bearer can be retrieved from developer tools->network->name:events->request headers)