The Vinyl is a unique web app that lets users experience their favorite modern tracks on a retro vinyl player interface. By connecting to their premium Spotify account, users can enjoy the nostalgic aesthetic of vintage vinyl while listening to their curated albums and tracks.
-
Clone the repo
git clone https://github.com/CPNV-ES/AWA1_The_Vinyl.git
-
Install NPM packages
npm install
-
Copy the
.env.examplefile and rename it to.env. Fill in the required information. You'll need to create a Spotify Developer account and create a new app to get the required keys. -
Run the project
npm run dev
The project uses Conventional Commits. The keywords used are: feat, fix, chore, refactor, test, docs. The commits are named with the following pattern: type: description eg.(feat: add awsome feature).
The project uses Gitflow. The branches used are: main, develop, feature, release, hotfix. The branches are named with the following pattern: type/short-description eg.(feature/awsome-feature).
The project uses SemVer. The versioning is done with the following pattern: major.minor.patch eg.(1.0.0).
The project uses the Spotify Web API to log in and control the user's queue and playing track.
In the other hand, the Spotify Web Playback SDK is used to play the tracks on the web app and control the media control (play, pause, next, previous).
Further information can be found on our wiki.