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.
- Friend Comparable Charts: Compare your Spotify stats with friends in personalized charts.
- Add Friends: Build a network of friends and explore their music preferences.
- 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.
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
- Firebase account for database configuration
- Spotify Developer account to set up API credentials
-
Fork the Repository Click the
Fork
button 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
.env
file in the root directory and configure the following environment variables:SPOTIFY_CLIENT_SECRET = SPOTIFY_CLIENT_ID = FIREBASE_API_KEY = FIREBASE_AUTH_DOMAIN = FIREBASE_PROJECT_ID = FIREBASE_STORAGE_BUCKET = FIREBASE_MESSAGING_SENDER_ID = FIREBASE_APP_ID = NEXTAUTH_URL =
-
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
Fork
button 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!