Gabrielpatrola/sample-nestjs-backend

🤖 Sample backend with NestJs

Sobre · Tecnologias utilizadas · Como usar · Material de apoio

💭 Sobre

Funcionalidade da interface

A API atende os seguintes critérios:

• Receberá uma planilha de produtos (segue em anexo), que deverá ser processada em background (queue)
• Ter um endpoint que informe se a planilha foi processada com sucesso ou não
• Seja possível visualizar, atualizar e apagar os produtos (só é possível criar novos produtos via planilha).

👨‍💻 Tecnologias Utilizadas

• Typescript
• Nestjs
• Docker

⁉ Como usar

🤔 Pré-requisitos

Para conseguir utilizar a aplicação sem nenhum problema é necessário ter em sua máquina:

• Ter em sua máquina o NPM ou Yarn para o gerenciamento dos pacotes da aplicação
• Ter o Docker para facilitar o setup do banco de dados e redis
• E não menos importante, o Git para clonar o repositório em seu computador

📝 Passo a passo

Primeiro clone o repositório em seu computador, por meio do terminal utilizando o comando:

1. Clonando o repositório

  # Clone o repositório
  $ git clone https://github.com/Gabrielpatrola/sample-nestjs-backend.git
  # Entre na pasta raiz da aplicação
  $ cd sample-nestjs-backend

2. Instalar as dependências da aplicação

  $ yarn # ou npm install

3. Configurar as variáveis de ambiente

Crie um arquivo chamado de '.env' copiando as informações existentes no arquivo '.env.example'.

4. Iniciar docker da aplicação, este ja iniciará o mysql + redis

  # Comando para iniciar a aplicação em modo de desenvolvimento
  $ docker-compose up -d

5. Inicie a aplicação

  $ yarn start:dev # ou npm run start:dev

5. Testando a aplicação

  # Comando para realizar os testes
  $ yarn test:e2e # ou npm run test:e2e

📚 Material de apoio

• Postman com as requisições

---

^{Feito com 💙 por Gabriel Patrola.}