caiovinicius7 / todo-app Goto Github PK

Esse projeto foi desenvolvido para obter conhecimentos a respeito do framework NestJS, o projeto se trata é uma api gerenciamento de tarefas, onde o usuário pode adicionar, listar, remover e editar tarefas.

O sistema conta com as seguintes funcionalidades:

• Cadastro de tarefa

• Listagem de tarefas

• Listagem de tarefa por id

• Edição de tarefa

• Exclusão de tarefa

Antes de começar, você vai precisar ter instalado em sua máquina: Node, Git, Docker e Insominia ou Postman.

# Clone este repositório
$ git clone https://github.com/CaioVinicius7/todo-app.git

# Acesse a pasta do projeto no terminal/cmd
$ cd todo-app

# crie o arquivos .env e o preencha seguindo o aquivo .env.example

# Baixe as dependências
$ yarn ou npm install

# Faça o build dos containers
$ docker-compose build

# Execute os containers
$ docker-compose up -d

# baixe as dependências
$ yarn

# Rode o projeto
$ yarn start:dev

# O servidor ficara ativo na porta:3333 - acesse <http://localhost:3333>

Para ter acesso a documentação utilize a rota /api-docs após a inicialização da aplicação, como no exemplo abaixo ou clique aqui.

http://localhost:3333/api-docs/