RamezTaher / Incedo-Internship-Challenge

INCEDO INTERNSHIP CHALLENGE

This is a Node.js REST API application that has the following features:

• Searching for an artist by name from a third party api.
• Writing the result to a user-supplied CSV filename.
• Retrieveing random artists from a JSON file if no results are found from the third party api.
• A Swagger documentation.

---

To run locally, the fastest way is using docker.

0. Prerequisites

• docker* (version 20 minimum)
• make (optional)

If make is not installed, you can check the ./Makefile for the needed commands.

You can run the following commans to check if docker is installed:

• docker -v

1.a Running the app

make start

1.a Stopping the app

make stop

---

You can also run it locally with nodejs directly

0. Prerequisites

• node (preferably version 16.X or plus)
• npm

1 Running the app (dev)

npm run dev

2 Running tests

npm test

---

Swagger

• you can view the endpoints documentation on http://localhost:5000/api-docs