juliorosseti / awards

A RESTful API to facilitate the reading and analysis of the list of nominees and winners in the Worst Film category of the Golden Raspberry Awards.

Golden Raspberry Awards

Worst Movies

A RESTful API to facilitate the reading and analysis of the list of nominees and winners in the Worst Movies category of the Golden Raspberry Awards. The application meets a series of functional and non-functional requirements to ensure efficiency, ease of use, and data integrity.

Project technologies

• Express
• SQLite3
• Sequelize

Recommended IDE Setup

• VS Code
• EditorConfig for VS Code
• Prettier - Code formatter
• Trailing Spaces
• GitLens
• Docker

Setup

You just need to have make pkg and docker installed in your workspace.

Recommended to read the Makefile to see the all commands

Build docker image

$ make docker_build

Start container (detached mode default)

$ make up

URL to access the endpoint API

http://localhost:3000

Tests

A prerequisite for running both tests is to have the application container running. Please follow the steps in the #setup section to have a running container.

Unit tests

$ make tests_unit

Integration tests

$ make tests_integration