backend_challenge_tascom

Este projeto foi desenvolvido para o desafio técnico de backend da Tascom.

Descrição

O projeto consiste em uma API RESTful que permite a criação, listagem, atualização e remoção de tarefas e etiquetas. As etiquetas podem ser associadas a uma ou mais tarefas. Os usuários podem se cadastrar e autenticar para acessar as funcionalidades da API.

A API foi desenvolvida com Node.js, Express e MongoDB.

Estrutura de diretórios

/...
  /src
  |__/controllers       # Controladores da API    
  |__/databases         # Configuração do banco de dados
  |__/docs              # Documentação da API
  |__/dto               # Objetos de entrada e saída
  |__/env               # Variáveis de ambiente
  |__/errors            # Tratamento de erros
  |__/middleware        # Middleware
  |__/models            # Modelos de dados
  |__/repositories      # Camada de acesso a dados
  |__/routes            # Endpoints da API
  |__/services          # Regras de negócio
  |__/utils             # Funções utilitárias
  |__/index.ts          # Arquivo de inicialização
/...

Utilização

Pré-requisitos

Node
MongoDB (local ou remoto)

Execução local

Clone o repositório
Instale as dependências com npm install
Crie um arquivo .env na raiz do projeto com as variáveis de ambiente presentes no arquivo .env.example e preencha com as suas credenciais
Inicie o servidor com npm run start. Caso prefira, use npm run start:dev para iniciar o servidor em modo de desenvolvimento

Documentação

A documentação da API foi feita com o Swagger e pode ser acessada em http://localhost:8080/api/docs

Licença

MIT

Nasc1mento/BackendChallengeTascom