📝 Task Registration

Bem-vindo(a)!!

Opa dev tudo bem?! Este projeto foi o primeiro desafio do programa de bolsas da compass, onde este time estará refazendo o desafio, com o conhecimento um pouco mais avançado que da primeira vez, utilizando o usando scrum. Espero que goste!!

Vamos ao projeto! #dreamBigger🚀💛

Status code: Finalizada!! ✔

Indice

• 🧠 Contexto
  • Rotas
• 📥 Baixar e executar o projeto
  • Setup da aplicação
  • Iniciando a aplicação
• 🧪 Testando rotas
• 🛠 Tecnologias
• ✍🏼 Autores
• 📝 Licença
• 🎁 Bonus

🧠 Contexto

Característica do Desafio: 🚧 API REST FULL 🚧

Este desafio será a criação de um "trelo" ou "bloco de notas" para o cadastro de tasks. Nesta API terá os fluxos de:

• Interação de métodos http. (criar, buscar, editar e remover);
• Busca por query params;
• Paginação;

📔 Project

Rota: http://localhost:<PORT>/api/v1/project

<Back

📥 Baixar e executar o projeto

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Postman e MongoDB. Além disto é bom ter um editor para trabalhar com o código como VSCode.

💻 Setup da aplicação

# Clone este repositório
$ git clone <https://github.com/br3nds0n/Deep-web-Group.git>

# Acesse a pasta do projeto no terminal
$ cd Deep-web-Group

# Instale as dependências
$ npm install

⚙ Configurar as variáveis de ambiente

Será necessário criar na raiz do projeto um arquivo .env configurar as variáveis. Exemplo:

# Porta que o servidor irá rodar.
PORT=3000

# Endereço para conectar com o Mongo.
# Exemplo:
DB_HOST=mongodb://localhost:27017/<name>

▶ Iniciando a aplicação

Após configurar as variáveis ambientes no .env. Iremos executar o seguinte comando para rodar a aplicação:

# Rodando em modo de produção
$ npm start


# Rodando em modo de produção
$ npm run dev

# O projeto inciará na porta:<PORT> - acesse <http://localhost:<PORT>/api/v1/> no postman

<Back

🧪 Testando rotas

Para testar as rotas abra um novo terminal:

# Use o script de tests
$ npm run test

# Será rodado os testes de feature no terminal

Resultado esperado:

<Back

🛠 Tecnologias

As seguintes ferramentas/tecnologias foram usadas na construção e testagem do projeto. Clicando no icone da tecnologia, você será redirecionado para o site oficial para instalação:

logo	Framework	Version
	NodeJs	16.13.1
	MongoDB	5.0.5
	Postman	9.6.2
	VsCode	1.63.2

<Back

✍🏼 Autores

---

📝 LICENÇA

Esse repositório está licenciado pela MIT LICENSE. Para mais informações detalhadas, leia o arquivo LICENSE contido nesse repositório.

<Back

🎁 Bonus