A music library API, built with Express, Node.js, Sequelize and MySQL. A Manchester Codes bootcamp project.
You can see the code by exploring this repository. You can also see a live demo of the API in action by visiting any of the following URLs:
[Please note there is no front-end element of this project, the links below will return the raw data from the database - try opening the links in Firefox, which will format the data automatically]
See all artists in the database: https://music-library-mcr-codes.herokuapp.com/artists
See a particular artist record: https://music-library-mcr-codes.herokuapp.com/artists/1
See all albums by a particular artist: https://music-library-mcr-codes.herokuapp.com/artists/1/albums
See all songs on a particular album: https://music-library-mcr-codes.herokuapp.com/albums/1/songs
(This is just a selection of the requests this API can handle - see app.js for all available routes)
This music library REST API project consists of a MySQL relational database, with tables containing information about music artists, albums and songs, and a REST API for interacting with the database to perform CRUD (create, read, update, delete) operations. The API itself has been built using Express and it uses the Sequelize Object Relational Mapper (ORM) to interact with the MySQL database.
Using the API, the user can send HTTP requests to perform CRUD (create, read, update, delete) actions on the music library database.
The API was created using Test Driven Development methodology, using Mocha, Chai and Supertest for automated testing. Postman was also used for testing during development, in conjunction with MySQL Workbench.
In addition, Docker was used as a system-agnostic environment in which to create and run the MySQL database locally. Dotenv was used to handle the environment variables and Nodemon was used during development as a useful tool to refresh the app after making changes to the Express app.
Screenshot of the API deployed using Heroku. This shows the result of a GET request to show all artists in the database:
Using Postman & MySQL Workbench for testing during development:
This API was created as part of the Manchester Codes Software Engineering course. The project covered the following concepts:
- Databases & database design
- Data schema
- API development
- Using SQL & MySQL
- Using an ORM to interact with a database
- Database querying and CRUD operations
- Test Driven Development(TDD)
- Express
- Sequelize
- MySQL & MySQL Workbench
- Mocha, Chai and SuperTest
- Docker
- Node.js and Node Package Manager
- Git & GitHub
- Dotenv
- Nodemon
- Postman
- Heroku
- JavaScript
- SQL
The API has the following functionality:
- Create new artists, albums or songs
- Get a list of all artists, all albums or all songs in the database
- Query the data to retrieve specific artists, or albums/songs by specific artists, or even individual albums or songs
- Update artist, album or song records in the database
- Delete artist, album or song records from the database
Project is: COMPLETE
Project created as part of Manchester Codes Full Stack Engineer bootcamp course.
An extra thank you to Rita Łyczywek for this excellent README template
Created by @jlopenshaw - feel free to contact me about the project