gittmaan / music-api

A REST-API for storing metadata of music tracks to a Relational Database, fetching the metadata from the external Spotify REST API.

Music API

Overview

A REST-API for storing metadata of music tracks to a Relational Database, fetching the metadata from the external Spotify REST API.

Quickstart

Use degit to scaffold the repository:

npx degit gittmaan/music-api

Or clone it manually with git:

git clone https://github.com/gittmaan/music-api.git

Note: Don't forget to delete the .git folder.

Create an environment configuration file (.env):

cp .env.example .env

Start the database with docker-compose:

docker-compose up --build -d

Initialize the database and run the migrations:

npm run knex:migrate:latest

Start the application with:

npm run dev

Now, go to your browser and open http://localhost:3000.

Backend

Backend is available at

1. http://localhost:3000/api/v1/artists.
2. http://localhost:3000/api/v1/artists/:id.
3. http://localhost:3000/api/v1/tracks/:isrc.

Frontend

Frontend is available at http://localhost:3000.