README
¶
Record
An interactive story of your music listening habits.
Authors
Tech Stack
Client: React, MaterialUI-Base
Server: Go, GRPC, Python
CI/CD: Docker, Github Actions, Kubernetes
Features
- Autogenerated playlists built and tweaked from Spotify Recommendations
- View top artists, top genres, and top songs for your specific user profile
- View the popularity of the artists you listen to in comparison to the general population
Run Locally
Record is made up of a few microservices.
To start the api, core, and session_manager microservices, run the following.
go run cmd/main.go
To start the web microservice, run the following.
npm start
Make sure the ports 3000, 8080, 7070, and 6060 are all open for services to use.
Environment Variables
To run this project, you will need to add the following environment variables to your .env file
SPOTIFY_ID
SPOTIFY_SECRET
REDIRECT_URL
FRONTEND_URL
The two Spotify variables can be obtained from their developer dashboard.
The REDIRECT_URL should be set to http://localhost:8080/callback and the FRONTEND_URL should be set to http://localhost:3000 if running locally.
Roadmap
- Mobile client
- More complete recommendation explorer
- View song metadata (eg. BPM, dancability)
Directories