Skip to content

allennguyen01/Jukeboxd

Repository files navigation

Logo

Jukeboxd

About The Project

https://jukeboxd-azure.vercel.app/

Check out the demo video:

Demo video

Jukeboxd is the ultimate social platform for music lovers and audiophiles. Inspired by the community-driven success of Letterboxd, Jukeboxd offers a space for users to discover, rate, and review albums across all genres. No matter what music you're into, Jukeboxd lets you express your opinions and connect with others who share your taste in music.

Whether you're a casual listener or a hardcore music enthusiast, Jukeboxd provides the perfect platform to dive deeper into the world of music, discover new sounds, and share your love of albums with a vibrant community.

Deployment Status

Vercel Deploy

Tech Stack

  • Frontend: TypeScript, Vite, Tailwind CSS, shadcn/ui
  • Database: Supabase (PostgreSQL Database, Auth)
  • APIs: Spotify

Features

  • User can register for an account storing their name, email/username and password then login to the app using their credentials
  • User can search up albums that go to their own separate page with details (cover art, artists, producers, release date, tracks in the album, etc.)
  • User has a profile that displays the ratings and reviews they have uploaded
  • User can write a review or rate music on the separate music pages

Bonus features

  • Users can get personalized recommendations based on their ratings and reviews
  • Users can like other people's reviews
  • User can create a post about a song/album with a caption
  • User can follow other users and see their ratings, reviews, and posts
  • User can write a comment on posts
  • User can create a playlist and share that as a post (slide carousel)

Getting Started

Prerequisites

  • Node.js v18 or higher
  • pnpm used as the package manager
  • Supabase project with API key (used for authentication/data storage)
  • Spotify API project with client ID and secret (used for getting music metadata)
  • .env file with URLs and API keys (e.g., Supabase, Spotify, etc.)

Installation

git clone https://github.com/allennguyen01/Jukeboxd.git
cd Jukeboxd # change directory to project
pnpm install # install dependencies
pnpm dev # view application in dev mode

Environment Variables

Create a .env file in the root of the project and add the following:

VITE_SUPABASE_URL=your-supabase-url
VITE_SUPABASE_API_KEY=your-api-key
VITE_SPOTIFY_CLIENT_ID=your-client-id
VITE_SPOTIFY_CLIENT_SECRET=your-client-secret

Contributing

  1. Fork the repo
  2. Create your feature branch (git checkout -b feature/foo)
  3. Commit your changes (git commit -m 'Add feature foo')
  4. Push to the feature branch (git push origin feature/foo)
  5. Open a pull request

About

Letterboxd-inspired platform to discover, rate, and review albums.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published