Skip to content

Latest commit

 

History

History
295 lines (232 loc) · 7.59 KB

README.md

File metadata and controls

295 lines (232 loc) · 7.59 KB

⭐️ Spring - Music Player ⭐️

The Spring Music Player with JioSaavn API Integration is a web application that allows users to listen to their favorite music tracks using the JioSaavn music streaming service. It provides a seamless and user-friendly interface for discovering, playing, and managing music playlists.


✨ Features ✨

  • Music/Album/Playlists/Singer Search
  • Playback Controls
  • Top 10 search list
  • Loop Playback
  • User authentication

🚀 Tech Stack

Client: React

Server: Node, Express, Firebase, Axios

API: API Link


🎨 Expected Design

Screenshot 2024-06-07 012636

Check the Expected design in Figma


🛠️ Getting Started

With Docker

  1. Clone the repository
 git clone https://github.com/Satyam1923/Spring.git

For Backend

  1. Navigate to the backend folder
cd backend
  1. Build Docker Image
docker build -t backend:v1 .      
  1. Run Docker Image
docker run -p 3030:3030 backend:v1 
  1. Access it locally

Go to http://localhost:3030/

For Frontend

  1. Navigate to the frontend folder
cd frontend
  1. Build Docker Image
docker build -t frontend:v1 .      
  1. Run Docker Image
docker run -p 3000:3000 frontend:v1
  1. Access it locally

Go to http://localhost:3000/

Without Docker

  1. Clone the repository
 git clone https://github.com/Satyam1923/Spring.git

For Backend

  1. Navigate to the backend folder
cd backend
  1. Install npm packages
npm install .
  1. Run the server
node index.js
  1. Access it locally

Go to http://localhost:3030/

For Frontend

  1. Navigate to the frontend folder
cd frontend
  1. Install npm packages
npm install .
  1. Run the development server
npm run dev
  1. Access the local server. You will receive a link in your terminal.

  2. Make dummy firebase project and Use it's config in firebase.js

Contributing Readme.

For someone working on backend

  1. Change directory
cd backend
  1. Install npm packages
npm install .
  1. Go to localhost
https://localhost:3030/

For someone working on frontend

  1. Change directory
cd frontend
  1. Install npm packages
npm install .
  1. Run server
npm run dev
  1. Make dummy firebase project and Use it's config in firebase.js

For someone working on backend+frontend

  1. Change directory
cd backend
  1. Install npm packages
npm install .
  1. Go to localhost
https://localhost:3030/
  1. Change directory
cd frontend
  1. Install npm packages
npm install .
  1. Change directory
cd  src
  1. Make dummy firebase project and Use it's config in firebase.js

🤝 Contributing

GitHub repo Good Issues for newbies GitHub Help Wanted issues GitHub Help Wanted PRs GitHub repo Issues

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  • If you have any suggestions for the projects, like reporting a bug, improving UI/UX, or enhancing the README.md file, feel free to open an issue to discuss it.
  • Please ensure your pull request adheres to good practices and standards.
  • Please ensure your pull request have reference to the issue assigned.
  • Please make sure you check your spelling and grammar.
  • Create individual Pull Requests for each issues.

🔧Creating a Pull Request

  1. Fork the Project
  2. Clone your forked repository
git clone https://github.com/Satyam1923/Spring.git
  1. Create a new branch and move to it
git checkout -b fix-issue-<ISSUE-NUMBER>
  1. Make your changes, then check the status of changed files
git status 
  1. Add all the files to the staging area
git add .

or

git add <file_name1> <file_name2>
  1. Commit your changes with a descriptive message
git commit -m "<EXPLAIN-YOUR_CHANGES>"
  1. Push your changes to your branch
git push origin fix-issue-<ISSUE-NUMBER>
  1. Open a Pull Request

Feel free to enhance this project and contribute in any way you find valuable! Let's make Spring Music Player even better together. 🎶✨


Open Source Programs

GSSOC Logo GSSOC 2024
This project is part of GirlScript Summer of Code. We're excited to have contributions from the community to help make Spring-Music-Player even better.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.


License

This project is licensed under the MIT License.


Contributors

Thank you for contributing to our project! Your support is invaluable in enhancing Spring-Music-Player and making it even better. 😊