alexgeis / music-player

browser audio player

Music Player

A player for showcasing my music.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• React.js

(back to top)

Getting Started

Instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/alexgeis/music-player.git

2. Install NPM packages

   npm install

3. DEVELOPMENT - run "npm start" to spin up the development server

   npm start

(back to top)

Usage

Use the player buttons (play, pause, shuffle, skip, etc.) to navigate through the playlist, and utilize the search bar to quickly find a specific track.

Genre labels at the top of the player can be used to filter for specific sounds, and can be deselected if needed.

(back to top)

Roadmap

• Upload more music
• Update color scheme
• Ability to include album art
• Ability to add URLs for a song/artist
• Add individual artist spotlight pages
• More filter options (song length, sort by played/unplayed, bpm)
• More song info (bpm, key, album, art, etc.)

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

(back to top)

Contributing

Any contributions you make are greatly appreciated.

Please try to create bug reports that are:

• Reproducible. Include steps to reproduce the problem.
• Specific. Include as much detail as possible: which version, what environment, etc.
• Unique. Do not duplicate existing opened issues.
• Scoped to a Single Bug. One bug per report.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Alex Geis - [e-mail]

Project Link: https://github.com/alexgeis/music-player

(back to top)

Acknowledgments

Helpful resources and kudos.

• Choose an Open Source License

• Shoutout to Madza for the helpful walkthrough on creating this player in React.js

(back to top)