• Sobre o Projeto
  • Objetivo
  • Recursos Principais
• Métodos da API
• Documentação
• Tecnologias Utilizadas
• Execução do Projeto
  • Clonando o Repositório
  • Instalando as Dependências
    • Utilizando npm
    • Utilizando yarn
  • Executando o Projeto
  • Inicializando o Banco de Dados
• Licença

Bem-vindo ao projeto VUTTR (Very Useful Tools to Remember), uma API projetada para simplificar o gerenciamento de ferramentas úteis. A aplicação VUTTR oferece um repositório onde você pode registrar suas ferramentas favoritas, incluindo seus nomes, links, descrições e tags.

O objetivo principal deste projeto é fornecer uma plataforma simples e eficaz para armazenar e organizar suas ferramentas de trabalho ou recursos on-line. A API oferece uma variedade de recursos para listar, adicionar, atualizar e excluir ferramentas, permitindo que você mantenha seu conjunto de ferramentas sempre atualizado e acessível.

• Listagem de Ferramentas: Visualize todas as suas ferramentas cadastradas ou filtre por tags específicas.
• Cadastro de Ferramentas: Adicione novas ferramentas à sua coleção especificando nome, link, descrição e tags.
• Atualização de Ferramentas: Atualize informações de ferramentas existentes, como título, link, descrição ou tags.
• Exclusão de Ferramentas: Remova ferramentas da sua lista quando necessário.

1. Listar Todas as Ferramentas

   • Método: GET
   • Endpoint: /tools

2. Listar Ferramentas por Tag

   • Método: GET
   • Endpoint: /tools?tag=tag1

3. Criar uma Nova Ferramenta

   • Método: POST
   • Endpoint: /tools

4. Excluir uma Ferramenta

   • Método: DELETE
   • Endpoint: /tools/:id

5. Atualizar uma Ferramenta

   • Método: PUT
   • Endpoint: /tools/:id

Para obter informações detalhadas sobre os métodos da API, bem como informações sobre o corpo das requisições e as respostas correspondentes, consulte o arquivo HTML de documentação disponível em ./docs/index.html. Lá você encontrará todas as informações necessárias para interagir com a API do projeto.

• Node.js
• Express.js
• MySQL
• mysql2
• Docker
• Docker Compose
• BlueprintAPI

Para executar este projeto em sua máquina local, siga os passos abaixo:

Primeiro, clone este repositório para o seu sistema local usando o seguinte comando:

git clone https://github.com/bkmoises/VUTTR-Challenge

Após clonar o repositório, navegue até o diretório raiz do projeto e instale as dependências necessárias.

npm install

yarn install

Isso instalará todas as bibliotecas e módulos necessários para o projeto.

Agora que você configurou o projeto, pode executá-lo com o seguinte comando:

npm run prod

Isso irá compilar e iniciar o projeto em modo de produção. Em seguida, você pode acessar o projeto em seu navegador em http://localhost:3000.

Este projeto depende de um banco de dados MySQL. Você pode facilmente configurar uma instância do MySQL usando o Docker Compose. Certifique-se de ter o Docker e o Docker Compose instalados em sua máquina.

No diretório raiz do projeto, você encontrará um arquivo docker-compose.yml que contém a configuração necessária para o MySQL. Execute o seguinte comando para iniciar o contêiner do MySQL:

docker-compose up -d

Isso irá iniciar o MySQL em um contêiner separado, que pode ser acessado pelo projeto.

Este projeto está sob a licença MIT. Consulte o arquivo LICENSE para obter mais detalhes.