Skip to content

Commit 776478f

Browse files
authored
Create README.md
1 parent b10d346 commit 776478f

File tree

1 file changed

+116
-0
lines changed

1 file changed

+116
-0
lines changed

README.md

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
# 🎵 Spring Music
2+
3+
A modern music streaming web app built with **Next.js**, **Firebase**, and **JioSaavn API**.
4+
It allows users to explore songs, stream music, and manage playlists in a seamless experience.
5+
6+
🚀 **Live Demo:** [Click here to try it](https://spring-music-player-n27p.vercel.app)
7+
8+
---
9+
10+
## ✨ Features
11+
12+
- 🎧 Stream music from the **JioSaavn API**
13+
- 🔍 Search songs, albums, and artists in real-time
14+
- 🔐 User authentication (Google/Email login) via Firebase
15+
- 📂 Save user data & playlists with Firestore (future implementation)
16+
- ⚡ Super-fast rendering with Next.js
17+
18+
---
19+
20+
## 🛠️ Tech Stack
21+
22+
- **Frontend:** [Next.js](https://nextjs.org/) + React
23+
- **Music API:** [JioSaavn API (Unofficial)](https://github.com/sumitkolhe/jiosaavn-api)
24+
- **Backend & Auth:** [Firebase](https://firebase.google.com/)
25+
- **Database:** Firebase Firestore
26+
- **Storage:** Firebase Storage
27+
- **Deployment:** Vercel
28+
29+
---
30+
31+
## 📂 Project Structure
32+
33+
```
34+
spring-music-web/
35+
├── public/ # Static assets
36+
├── src/ # Source code
37+
│ ├── components/ # Reusable UI components
38+
│ ├── pages/ # Next.js pages (routes)
39+
│ ├── styles/ # Global & module CSS
40+
│ └── utils/ # Firebase & JioSaavn API helpers
41+
├── .env.local # Environment variables
42+
├── package.json
43+
└── README.md
44+
```
45+
46+
---
47+
48+
## ⚡ Getting Started
49+
50+
### 1. Clone the repository
51+
```bash
52+
git clone https://github.com/yourusername/spring-music-web.git
53+
cd spring-music-web
54+
```
55+
56+
### 2. Install dependencies
57+
```bash
58+
npm install
59+
# or
60+
yarn install
61+
```
62+
63+
### 3. Setup Firebase
64+
1. Go to [Firebase Console](https://console.firebase.google.com/)
65+
2. Create a new project
66+
3. Enable Authentication (Google/Email)
67+
4. Setup Firestore Database
68+
5. Setup Firebase Storage
69+
6. Copy your Firebase config
70+
71+
### 4. Add environment variables
72+
Create a `.env.local` file in the root directory:
73+
```env
74+
NEXT_PUBLIC_FIREBASE_API_KEY=your_api_key
75+
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
76+
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
77+
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_project.appspot.com
78+
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
79+
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
80+
JIO_SAAVAN_API_BASE_URL=your-api
81+
NEXT_PUBLIC_API_URL=your_api_url
82+
```
83+
84+
### 5. Run the project locally
85+
```bash
86+
npm run dev
87+
# or
88+
yarn dev
89+
```
90+
Now open [http://localhost:3000](http://localhost:3000) 🎉
91+
92+
---
93+
94+
## 📦 Deployment
95+
96+
### Deploy on Vercel
97+
```bash
98+
vercel
99+
```
100+
101+
---
102+
103+
## ​ Contributors
104+
105+
A big shout-out to all the amazing people who’ve contributed to this project:
106+
107+
<a href="https://github.com/Satyam1923/Spring-Music-Player/graphs/contributors">
108+
<img src="https://contrib.rocks/image?repo=Satyam1923/Spring-Music-Player" />
109+
</a>
110+
111+
112+
## 📜 License
113+
114+
This project is licensed under the **MIT License**.
115+
116+
---

0 commit comments

Comments
 (0)