https://github.com/pranshu05/tunestats
Your Spotify stats, re-imagined — rate, share, and connect with friends.
https://github.com/pranshu05/tunestats
analytics authentication charts comments comments-system friends nextjs postgresql profile-page ratings ratings-app social-network spotify spotify-api tailwindcss typescript
Last synced: about 17 hours ago
JSON representation
Your Spotify stats, re-imagined — rate, share, and connect with friends.
- Host: GitHub
- URL: https://github.com/pranshu05/tunestats
- Owner: pranshu05
- License: mit
- Created: 2023-05-11T04:36:32.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-05-14T10:41:05.000Z (5 months ago)
- Last Synced: 2025-05-14T11:48:55.032Z (5 months ago)
- Topics: analytics, authentication, charts, comments, comments-system, friends, nextjs, postgresql, profile-page, ratings, ratings-app, social-network, spotify, spotify-api, tailwindcss, typescript
- Language: TypeScript
- Homepage: https://tunestats.vercel.app
- Size: 18 MB
- Stars: 9
- Watchers: 1
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# TuneStats 🎵
**TuneStats** is a web application that allows users to track their Spotify stats, share their profiles, and compare their music taste with friends.
## 🚀 Features
- **Spotify Authentication**: Securely log in with your Spotify account.
- **Sharable User Profiles**: Generate personalized, shareable profiles for showcasing your Spotify activity.
- **Comments Section**: Engage with the community by leaving comments on profiles, tracks/albums/artist pages.
- **Rating System**: Rate your favorite tracks, albums, and artists just like IMDb but for Spotify!.
- **Add Friends**: Build a network of friends and explore their music preferences.
- **Friend Comparable Charts**: Compare your Spotify stats with friends in personalized charts.
- **Privacy Control**: Set your profile as public or private based on your preference.
- **Responsive Design**: Enjoy a seamless experience across all devices.
- **Artist Page**: View detailed information about your favorite artists.
- **Track Page**: Explore detailed insights about your top tracks.
- **Album Page**: Discover more about your favorite albums.
- **Global Stats**: View global stats of all top tracks, albums, and artists.
- **Personalized Album Chart**: Get a personalized album chart based on your Spotify listening history.
---
## 🛠️ Getting Started
Follow these steps to set up TuneStats on your local machine:
### Prerequisites
Make sure you have the following installed:
- Node.js (v16 or later)
- npm or yarn
- Spotify Developer account to set up API credentials
### Installation
1. **Fork the Repository**
Click the `Fork` button on the top right of this repository to create your copy.
2. **Clone the Repository**
Clone your forked repo to your local machine:
```bash
git clone https://github.com/pranshu05/tunestats.git
cd tunestats
```
3. **Install Dependencies**
Install the required packages using npm or yarn:
```bash
npm install
```
or
```bash
yarn install
```
4. **Set Up Environment Variables**
Create a `.env` file in the root directory and configure the following environment variables:
```env
SPOTIFY_CLIENT_ID=`your_spotify_client_id`
SPOTIFY_CLIENT_SECRET=`your_spotify_client_secret`
NEXTAUTH_SECRET=`your_nextauth_secret`
NEXTAUTH_URL=`http://localhost:3000`
DATABASE_URL=`your_database_url`(neon db)
```
5. **Setup Database**
- Create a Neon database and set up the connection string in your `.env` file.
- Run the DDL scripts from [DDL Script File](/db/create_tables.sql) to create the necessary tables in your database.
6. **Run the Development Server**
Start the development server:
```bash
npm run dev
```
or
```bash
yarn dev
```
7. **Open in Browser**
Open http://localhost:3000 to view the app.
---
## 🤝 Contribution Guidelines
We welcome contributions! Follow these steps to contribute:
1. **Fork the Repository**
Click the `Fork` button on the top right of this repository to create your copy.
2. **Create a Feature Branch**
```bash
git checkout -b feature/
```
3. **Make Your Changes**
Add your changes and commit:
```bash
git add .
git commit -m "Add "
```
4. **Push Your Changes**
```bash
git push origin feature/
```
5. **Open a Pull Request**
Go to the original repository and open a pull request describing your changes.
---
## 📝 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
---
### 🌟 Support
If you like this project, please give it a star ⭐ and share it with your friends!