SingMeASong

📋 Description

• Allows the user to register song recommendations.

---

💻 Technologies and Concepts

---

🚀 API

POST /recommendations
    - Route to register a new recommendation
    - headers: {}
    - body: {
        "name": "Falamansa - Xote dos Milagres",
        "youtubeLink": "https://www.youtube.com/watch?v=chwyjJbcs1Y"
}

POST /recommendations/:id/upvote
    - Route to add one point to the recommendation
    - headers: {}
    - body: {}

POST /recommendations/:id/downvote
    - Route to remove one point from the recommendation
    - headers: {}
    - body: {}

GET /recommendations
    - Route to list recommendations
    - headers: {}
    - body: {}

GET /recommendations/:id
    - Route to list recommendations by id
    - headers: {}
    - body: {}

GET /recommendations/random
    - Route to get random recommendation
    - headers: {}
    - body: {}

GET /recommendations/top
    - Route to get top recommendations
    - headers: {}
    - body: {}

---

🏁 Running the application

Make sure you have the latest stable version of Node.js e npm running locally.

First, clone this repository on your machine:

git clone https://github.com/anaraquelmatos/SingMeASong.git

Then, inside the folder, run the following command to install the dependencies.

npm install

Finished the process, just start the server.

npm start