Skip to content
This repository has been archived by the owner on Aug 5, 2020. It is now read-only.

SrGMC/musify

Repository files navigation

Notice: Due to studies and other reasons, I'm currently unable to continue developing the project, however, new pull requests are welcome and I'll pick it up when my time allows.

Musify

JavaScript Style Guide

Musify is a simple and fast music player, built from the ground up, using web technologies such as HTML, CSS and JavaScript, all wrapped on Electron Framework. This is my first project as a computer science student. I've tried my best to write a code that follows common coding conventions, but keep in mind that you may find common beginner errors. If so, feel free to help and contribute to improve this app.

Development is now in the dev branch

Table of Contents

  • macOS: Version 0.8.3 - 62.9MB / .zip file Download

You can see the latest changes here.

Development

This app is built using Electron. It requires the following dependencies:

    dialogs
    electron
    electron-builder
    musicmetadata
    photonkit
    snazzy
    about-window

To start developing, run the following commands (you'll need Node.js and npm already installed in your system):

    git clone https://github.com/SrGMC/musify.git
    cd musify
    npm run-script postinstall

To run the app, simply execute:

    npm start

To fix js files, simply run:

    npm run-script fix

To build binary files, simply run one of the following:

    npm run-script package-mac
    npm run-script package-windows
    npm run-script package-linux

TODO

  • Shuffle songs (WIP in dev branch)
  • Loop only one song (WIP in dev branch)
  • Start song again when previous song button is pressed
  • Prevent adding an already added song
  • Code cleanup

Contributing

If you want to contribute, please follow this guidelines:

Feedback

Please fill and follow the following structure when opening issues Sections in bold are required

  1. Type:
  2. OS:
  3. OS version:
  4. App version:
  5. When did the bug happen?:
  6. What did you try when the bug happened?:
  7. Description/More information:

Code

Check out the CONTRIBUTING.md file

Changelog

All the releases can be found here.

beta 0.8.3:

  • Security updates

beta 0.8.2:

  • Fixed footer bar that hid the last items on the playlist
  • New logo by @moenawar #1
  • Added new about window

beta 0.8.1:

  • Fixes a problem where songs removed could still be played
  • Adds a clear button
  • Songs are now parsed on addition, not on-the-fly
  • Fixes a problem that notified continuously a song change when the playlist ended

License

Copyright @SrGMC. Released under GPL-3.0.

Acknowledgements