Skip to content

Latest commit

 

History

History
81 lines (48 loc) · 1.92 KB

README.md

File metadata and controls

81 lines (48 loc) · 1.92 KB
Raw

MUSIK

Musik is an elegant React.js Music Application, which is improved version of Spotify. With a modern homepage, fully-fledged music player, search, lyrics, song exploration features, search, popular music around you, worldwide top charts, and much more.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue.

System Requirements

To get started with development, you need to install few tools

  1. git

    git version 2.13.1 or higher. Download git if you don't have it already.

    To check your version of git, run:

     git --version

  2. node

    node version 16.15.1 or higher. Download node if you don't have it already.

    To check your version of node, run:

     node --version

  3. npm

    npm version 5.6.1 or higher. You will have it after you install node.

    To check your version of npm, run:

     npm --version

Setup

To set up a development environment, please follow these steps:

  1. Clone the repo

     git clone https://github.com/precious/musik.git

  2. Change directory to the project directory

    cd musik

  3. Install the dependencies

     npm install

    If you get an error, please check the console for more information.

    If you don't get an error, you are ready to start development.

  4. Run the app

    npm run dev

    Project will be running in the browser.

    Open http://localhost:3000 to view it in your browser.

Issues

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue on GitHub.