Skip to content

acolima/sing-me-a-song-api

Repository files navigation

Sing me a Song API

API for Sing me a Song, a application for videos recommendations. The recommendation is given based on their score.

Implemented features

  • Add a new music recommendation
  • Like or dislike (up or down vote)
  • Get a list of the videos with the hightest scores
  • Get a random video recommendation

Technologies

Node Express TypeScript PostgreSQL Prisma Jest

How to run

  1. Clone this repository
git clone git@github.com:acolima/sing-me-a-song-api.git
  1. Go to the project directory
cd sing-me-a-song-api
  1. Install dependencies
npm i
  1. Create a .env file with the same structure of .env.example and change the value of DATABASE_URL
DATABASE_URL=
  1. Create the database
npx prisma migrate dev
  1. Run project with
npm run dev

⭐ You can check the front-end repository of this project here and follow the instructions to run

How to run the tests

  1. Create a .env.test file with the same structure of .env.example and change the value of DATABASE_URL
DATABASE_URL=
  1. Create the tests database
npx dotenv -e .env.test prisma migrate dev
  1. Run project with
npm run dev:test
  1. Run tests
npm run test
  1. Run coverage tests
npm run test:coverage

Author

LinkedIn Gmail

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages