Mixtape Magic API

This is the backend repository providing database and API access to Mixtape Magic.

The API is written in JavaScript using Node.js & Express, and hosted on Render.

The database uses PostgreSQL, and hosted on Xata.

API

The API is used for the frontend application to interact with the database. Some important endpoints are:

• /api/playlists/
  • Fetches a list of all playlists.
• /api/playlists/:playlistID
  • Fetches more detailed information (including the songs) for one specific playlist, specified by :playlistID.
• /api/my-playlists/
  • Fetches a list of all playlists belonging to the currently logged-in user.
• /api/my-playlists/:playlistID
  • Allows requests to be made to view/edit a specific playlist belonging to the currently logged-in user, specified by :playlistID.
• /api/my-playlists/:playlistID/songs
  • Allows requests to be made to view/edit the songs of a specific playlist belonging to the currently logged-in user, specified by :playlistID.

More detailed information about all available endpoints, example request/response JSON, and HTTP status codes, can be found in the API Documentation.

Database

The PostgreSQL database contains the following tables:

• users
• playlists
• songs

More detailed information about the database, including the SQL used to create the tables and example SQL queries, can be found in the Database Documentation.

Using this repository

The following scripts have been included in package.json:

• "test": "echo \"Error: no test specified\" && exit 1"
• "start": "nodemon server.js"

Using npm run start will run the server, and allow it to automatically restart when any file changes are made.