An open-source web music player that brings a seamless music experience with the most modern UI.
- Fork the repo into your account
- Clone the project into your local machine
git clone https://github.com/<Your-name>/groovy.git- Navigate the folder
cd groovy- Install the dependencies
npm install- Run the project on local machine
npm run devThank you for considering to contribute to this project.
This project is in a very early stage so anybody who's familiar with ReactJS/NextJS/TailwindCSS can contribute. If you don't feel ready to make a contribution yet, no problem at all. You can also contribute to this ReadMe section or the Design part of our project.
If you are interested to contribute and want to learn more about the technologies that are used in this project, checkout the links below.
Never made an open source contribution before? And wondering how to contribute to this project? No worries! Here's a quick guide,
- Choose any feature/bug you wish to contribute to.
- Fork the repository into your own account.
- Clone the repo you have forked in your local machine using
git clone https://github.com/<Your-name>/groovy.git - Create a new branch for your fix by using the command
git checkout -b YourName-branch-name - Make the changes you wish to do and stage them using the command
git add files-you-have-changedor usegit add . - Use the command
git commit -m "Short description of the changes"to describe the changes you have done with a message. - Push the changes to your remote repository using
git push origin your-branch-name - Submit a PR(pull request) to the upstream repository (Aman-Mandal/groovy) with a title and a small description.
- Wait for the pull request to be reviewed by us.
- Make appropriate changes if the maintainer recommends you to and submit it.
- Await for your contribution to be merged into the repository.
Checkout the Contributing.md file before contributing.
If you need help, you can ask questions on our twitter for now :
Give a ⭐ to the project if you liked it. :)