orakeshi / rebmem-musicplayer

EPA music player for Rebmem created using electron

Rebmem Music Application

This is a music player built using electron for Rebmems hardware
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   Application Showcase
   • Built With
2. Getting Started
   • Installation
   • Prerequisites
   • Songs Tags
   • Things To Know
3. Steps To Use
4. Roadmap
5. Contact
6. Development Steps

About The Project

Application Showcase

This project was created for Rebmems hardware. The development was carried out over a deadline of 5 days. The application supports the typical functionality you would expect from a music player. Play, Pause, Seeking, Volume adjustment and more are all supported.

Tech Used:

• Electron - Used to create an application using web technologies
• Vue - Used as the framework for development

Built With

These are all the frameworks & programming languages that were used

• Electron
• Vue
• JavaScript

Getting Started

Below will show you how to get the application up and running on your local machine from this repository

Installation

1. Download the latest build from GDrive
   OR
   1.1. Download the repo OR Clone the repo

   git clone https://github.com/Orakeshi/Rebmem-MusicPlayer.git

Prerequisites

Songs Root Folder

1. You will need to make sure you have a "Music" folder in the root of your machine
2. This is where the application will pull the song data from

"C:\users\xxx\Music"

4. Image of the folder on a MacBook
   
5. Make sure that ANY song you want to listen to on the application is placed in the Music folder for either Mac Or Window

Songs Tags

1. The application provides images and song names by scraping the song metadata of an MP3.
   1. If your song is showing a default Rebmem logo as the image, it means your song doesnt have sufficient tag data to scrape
2. If your song doesnt have metadata you can provide metadata yourself via this link: https://overbits.herokuapp.com/mp3tageditor/

Things to know

If you have masses of songs, the application may experience CPU spikes whilst displaying the metadata

If the application interface is not updating press (Ctrl + R [Windows] OR CMD + R [Mac])

Any Songs without metadata will be given default tags

Only MP3 music format will be recognised

Steps to use

1. Store any songs in your Music directory at the root of your OS
2. Open the application
3. Enjoy your music

Sample songs to test can be found at: https://drive.google.com/drive/folders/1DXqxlhOzK0_znKzNvyLtafJWo-u2BrEz?usp=sharing

Roadmap

See the open issues for a list of proposed features (and known issues).

Contact

Orakeshi (Tommy) - [email protected]

Project Link: https://github.com/Orakeshi/Rebmem-MusicPlayer

Development Steps

Project setup -> Must be run

yarn install

Compiles and hot-reloads for development

yarn electron:serve

Compiles and minifies for production

yarn electron:build

Customize configuration

See Configuration Reference.