An open API service indexing awesome lists of open source software.

https://github.com/rajput-hemant/jiosaavn-api

๐ŸŽต A simple wrapper for the JioSaavn API powered by Hono.js ๐Ÿ”ฅ.
https://github.com/rajput-hemant/jiosaavn-api

api bun-api bun-runtime bunjs honojs jiosaavn-api jiosaavn-downloader music music-api nodejs typescript vercel

Last synced: about 1 month ago
JSON representation

๐ŸŽต A simple wrapper for the JioSaavn API powered by Hono.js ๐Ÿ”ฅ.

Awesome Lists containing this project

README

          

![][ci] ![][views] ![][stars] ![][forks] ![][issues] ![][license] ![][code-size] ![][commit-activity]

# ๐ŸŽต Jio Saavn API

### A simple wrapper for the Jio Saavn API powered by Hono.js ๐Ÿ”ฅ.

[**๐Ÿ“š Documentation**](https://jiosaavn.rajputhemant.me/docs) (Scalar UI) ยท [**OpenAPI JSON**](https://jiosaavn.rajputhemant.me/openapi.json)

## โœจ Features

- ๐Ÿš€ **Ultrafast** - Powered by [Hono.js](https://hono.dev).The router `RegExpRouter` is really fast.
- ๐Ÿชถ **Lightweight** - Has minimal dependencies.
- ๐ŸŒ **Multi-runtime** - Works on `Bun`, `Node.js`, `Vercel`, and `Cloudflare Workers`.
- ๐Ÿ”ฅ Download High Quality Songs, w/ lyrics for supported songs.
- ๐ŸŽต Get Songs, Albums, Playlists, Artists, Radio Stations, Podcasts Lyrics, Recommendations, and more.
- โค๏ธ Open Source

## ๐Ÿ“š API Documentation

- **Scalar API Reference**: `GET /docs`
- **OpenAPI JSON**: `GET /openapi.json`

## ๐Ÿ› ๏ธ Building from source

- Clone the repository

```
git clone https://github.com/rajput-hemant/jiosaavn-api
cd jiosaavn-api
```

- Install dependencies

```
bun i || pnpm i || npm i || yarn
```

#### Bun

> [!Warning]
> You need to have [Bun.js](https://bun.sh) installed on your machine to run the project with bun.

```
bun run dev || pnpm dev || npm run dev || yarn dev
```

## ๐ŸŒ Deploying your own instance

You can easily deploy your own hosted version of the `JioSaavn API` by clicking on one of the links below, which will set up a ready-to-go version for you:

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/rajput-hemant/jiosaavn-api)

[![Deploy with Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/rajput-hemant/jiosaavn-api)

> [!Important]
> Deploy in an India region so all APIs work properly. Recommended region: `Mumbai, India (South) - bom1`

> [!Note]
> For Cloudflare Workers, remove any `process`-related code before deploying.

### Build and Run Docker Image

#### Docker Compose (Recommended)

- Start the container

```
docker-compose up -d # detached mode
```

- Stop the container

```
docker-compose stop # stops the container
docker-compose down # stops and removes the container
```

#### Docker

- Start Docker daemon (Skip if already running)

```
sudo dockerd
```

- Build the image

```
docker build -t jiosaavn .
```

- Run the image

```
docker run -p 80:3000 jiosaavn
```

- Open http://localhost to view it in the browser.

- Stop the container

```
docker ps
```

```
docker stop
```

## ๐Ÿ“œ License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## ๐Ÿฆพ Contributors:


[views]: https://komarev.com/ghpvc/?username=jiosaavn-api&label=view%20counter&color=red&style=flat
[code-size]: https://img.shields.io/github/languages/code-size/rajput-hemant/jiosaavn-api
[issues]: https://img.shields.io/github/issues-raw/rajput-hemant/jiosaavn-api
[license]: https://img.shields.io/github/license/rajput-hemant/jiosaavn-api
[commit-activity]: https://img.shields.io/github/commit-activity/w/rajput-hemant/jiosaavn-api
[forks]: https://img.shields.io/github/forks/rajput-hemant/jiosaavn-api?style=flat
[stars]: https://img.shields.io/github/stars/rajput-hemant/jiosaavn-api
[ci]: https://github.com/rajput-hemant/jiosaavn-api/actions/workflows/ci.yml/badge.svg