ignaciojvig/HarryPotterMakeMagic

Make Magic Challenge

A API deste repositório foi construida sobre Node na versão 12.18.3, portanto, certifique-se de possuir o mesmo nessa versão ou superior.

Para executar a API, siga os seguintes passos:

Faça o clone do repositório https://github.com/ignaciojvig/HarryPotterMakeMagic
Dentro dele, execute o comando npm install para fazer o download de todas as dependências da aplicação
Por fim execute o comando npm run start para executar a API.

O projeto em questão realizou todos os requisitos propostos e contempla diversas features, dentre elas:

Persistência de Dados utilizando SQLite3 - gerenciado pela própria aplicação (Para 'resetar' o banco, basta excluir o arquivo e re-iniciar a API) incluindo mecanismo de Seeding
Docker para executar a aplicação dentro de um container (Dentro do package.json já existem dois comandos específicos para agilizar nesse passo. npm run docker:build e npm run docker:run
Cobertura de testes unitáros em 100% por meio do Jest e reports do Istanbul. Contudo, o projeto ainda possui espaços para mais testes unitários e testes de integração.
Mecanismo de Caching
Swagger que pode ser acessado no endereço localhost:3000/swagger

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

Running the app

# development

$ npm run start

  

# watch mode

$ npm run start:dev

  

# production mode

$ npm run start:prod

Test

# unit tests

$ npm run test

  

# e2e tests

$ npm run test:e2e

  

# test coverage

$ npm run test:cov

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

Author - Kamil Myśliwiec
Website - https://nestjs.com
Twitter - @nestframework

License

Nest is MIT licensed.

ignaciojvig / HarryPotterMakeMagic