LucasPereiraMiranda / tdd-products-api

API to study the fundamentals of Test Driven Development (TDD) & automated tests in general

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


TDD products api

GitHub language count Repository size GitHub last commit Repository issues GitHub license


πŸš€ Techs

TDD products api was developed with these technologies

πŸ’» Project

This project's API has been developed with the primary objective of studying and exploring the core principles of Test Driven Development (TDD) and automated testing in general.

This version provides more clarity and completeness by specifying the purpose of the API and emphasizing its objective of studying and exploring the principles of TDD and automated testing.

πŸ’₯ Installation

# clone this repo
$ git git@github.com:LucasPereiraMiranda/tdd-products-api.git

# run with compose services (app and mysql)
$ docker-compose up

# open new terminal and run migrations  (replace app_docker_container_id to our app docker container id)
$ docker run exec -it app_docker_container_id bash

# run migrations inside container
$ npm run typeorm migration:run

Image details to run migrations

migrations

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

About

API to study the fundamentals of Test Driven Development (TDD) & automated tests in general

License:Creative Commons Zero v1.0 Universal


Languages

Language:TypeScript 93.7%Language:JavaScript 4.7%Language:Dockerfile 1.2%Language:Shell 0.4%