TuneStats is a web application that allows users to track their Spotify stats, share their profiles, and compare their music taste with friends.
- 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.
Follow these steps to set up TuneStats on your local machine:
Make sure you have the following installed:
- Node.js (v16 or later)
- npm or yarn
- Spotify Developer account to set up API credentials
-
Fork the Repository Click the
Forkbutton on the top right of this repository to create your copy. -
Clone the Repository Clone your forked repo to your local machine:
git clone https://github.com/pranshu05/tunestats.git cd tunestats -
Install Dependencies Install the required packages using npm or yarn:
npm install
or
yarn install
-
Set Up Environment Variables Create a
.envfile in the root directory and configure the following environment variables: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)
-
Setup Database
- Create a Neon database and set up the connection string in your
.envfile. - Run the DDL scripts from DDL Script File to create the necessary tables in your database.
- Create a Neon database and set up the connection string in your
-
Run the Development Server Start the development server:
npm run dev
or
yarn dev
-
Open in Browser Open http://localhost:3000 to view the app.
We welcome contributions! Follow these steps to contribute:
-
Fork the Repository Click the
Forkbutton on the top right of this repository to create your copy. -
Create a Feature Branch
git checkout -b feature/<feature-name>
-
Make Your Changes Add your changes and commit:
git add . git commit -m "Add <feature-name>"
-
Push Your Changes
git push origin feature/<feature-name>
-
Open a Pull Request Go to the original repository and open a pull request describing your changes.
This project is licensed under the MIT License. See the LICENSE file for details.
If you like this project, please give it a star ⭐ and share it with your friends!