Satyam1923 / Spring-Music-Player

The Spring Music Player project aims to create a feature-rich music player application leveraging the multiple APIs. This application will provide users with a seamless experience to discover, stream, and organize their favorite music tracks from the extensive library.
https://spring-music-player.vercel.app/
MIT License
58 stars 127 forks source link
api-rest axios docker expressjs figma firebase firebase-auth javascript nodejs npm-package postman reactjs redux vercel-deployment vscode

⭐️ 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 ✨


🚀 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
  2. Build Docker Image
    docker build -t backend:v1 .      
  3. Run Docker Image
    docker run -p 3030:3030 backend:v1 
  4. 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 .      
  2. Run Docker Image
    docker run -p 3000:3000 frontend:v1
  3. 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
  2. Install npm packages
    npm install .
  3. Run the server
    node index.js
  4. Access it locally

Go to http://localhost:3030/

For Frontend

  1. Navigate to the frontend folder
cd frontend
  1. Install npm packages

    npm install .
  2. Run the development server

    npm run dev
  3. Access the local server. You will receive a link in your terminal.

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

Contributing Readme.

For someone working on backend

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

    For someone working on frontend

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

For someone working on backend+frontend

  1. Change directory
    cd backend
  2. Install npm packages
    npm install .
  3. Go to localhost
    https://localhost:3030/
  4. Change directory
    cd frontend
  5. Install npm packages
    npm install .
  6. Change directory
    cd  src
  7. 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.

🔧Creating a Pull Request

  1. Fork the Project

  2. Clone your forked repository

    git clone https://github.com/Satyam1923/Spring.git
  3. Create a new branch and move to it

    git checkout -b fix-issue-<ISSUE-NUMBER>
  4. Make your changes, then check the status of changed files

    git status 
  5. Add all the files to the staging area

    git add .

    or

    git add <file_name1> <file_name2>
  6. Commit your changes with a descriptive message

    git commit -m "<EXPLAIN-YOUR_CHANGES>"
  7. Push your changes to your branch

    git push origin fix-issue-<ISSUE-NUMBER>
  8. 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. 😊