Skip to content

Commit

Permalink
Merge pull request #76 from SuhainaFathimaM/master
Browse files Browse the repository at this point in the history
Fully updated Readme Documentation   DOC: Improvements in readme and learn documentation (Issue #74) fixed
  • Loading branch information
Satyam1923 authored May 12, 2024
2 parents ee2a800 + 94f9609 commit 3250870
Showing 1 changed file with 49 additions and 38 deletions.
87 changes: 49 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,106 +1,117 @@
# Spring - Music Player

# ⭐️ 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
## Features
- Music/Album/Playlists/Singer Search
- Playback Controls
- Top 10 search list
- Loop Playback

## Tech Stack
## 🚀 Tech Stack

**Client:** React, TailwindCSS

**Server:** Node, Express, Firebase, Axios

**Api:** Jio Saavn API unofficial (
http://jiosaavn-olj6ym1v4-thesumitkolhe.vercel.app )
**API:** JioSaavn API (unofficial) - [API Link](http://jiosaavn-olj6ym1v4-thesumitkolhe.vercel.app)

## 🎨 Expected Design
Check the design in [Figma](https://www.figma.com/file/mrTzLDEAtHPOsDl99R3kOY/Spring-Music-Player?type=design&node-id=0%3A1&mode=design&t=WCOysEPxmfpAsN12-1)


## Expected Design
link : https://www.figma.com/file/mrTzLDEAtHPOsDl99R3kOY/Spring-Music-Player?type=design&node-id=0%3A1&mode=design&t=WCOysEPxmfpAsN12-1
## 🌐 WebPage link

Visit the Spring Music Player [here](https://spring-music-player.vercel.app/)

## WebPage link
https://spring-music-player.vercel.app/
## Getting Started
1. Clone the repo
## 🛠️ Getting Started
1. **Clone the repository**

```sh
git clone https://github.com/Satyam1923/Spring.git
```

### For backend
1. Change to backend folder
### For Backend
1. **Navigate to the backend folder**
```sh
cd backend
```
2. Install npm packages
2. **Install npm packages**
```sh
npm install .
```
3. Run server
3. **Run the server**
```sh
node index.js
```
4. Start it in local host
Go to this url : http://localhost:3030/
### For frontend
1. Change to frontend folder
4. **Access it locally**

Go to http://localhost:3030/


### For Frontend
1. **Navigate to the frontend folder**

```sh
cd backend
```
2. Install npm packages
2. **Install npm packages**
```sh
npm install .
```
3. Run server
3. **Run the development server**
```sh
npm run dev
```
4. You'll have local host link in terminal
4. **Access the local server**
You will receive a link in your terminal.

## Contributing
## 🤝 Contributing

Contributions are what makes the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
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, or improving the README.md file, feel free to **open an issue** to discuss it, or directly create a pull request with the necessary changes.
- 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, or directly create a pull request with the necessary changes.
- Please ensure your pull request adheres to good practices and standards.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.
## Creating Pull Request
1. Fork the Project
2. Clone your forked repository
- Create individual Pull Requests for each suggestion.


## 🔧Creating a Pull Request
1. **Fork the Project**
2. **Clone your forked repository**
```sh
git clone https://github.com/Satyam1923/Spring.git
```
3. Now go ahead and create a new branch and move to the branch
3. **Create a new branch and move to it**
```sh
git checkout -b fix-issue-<ISSUE-NUMBER>
```
4. After you have added your changes, follow the following command chain
Check the changed files
4. **Make your changes, then check the status of changed files**
```sh
git status -s
git status
```

5. Add all the files to the staging area
5. **Add all the files to the staging area**
```sh
git add .
```
or
```sh
git add <file_name1> <file_name2>
```
6. Commit your changes
6. **Commit your changes with a descriptive message**
```sh
git commit -m "<EXPLAIN-YOUR_CHANGES>"
```
7. Push your changes
7. **Push your changes to your branch**
```sh
git push origin fix-issue-<ISSUE-NUMBER>
```
8. Open a Pull Request
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. 🎶✨**

0 comments on commit 3250870

Please sign in to comment.