Aplicação para gerenciamento de ferramentas
Sobre • Features • Pré-requisitos • Tecnologias • Autor
Tools HUB é uma aplicação criada a aprtir de um desafio backend da lista back-end chelenges, lista essa inspirada na iniciativa do Felipe Fialho, Front-end Challenge. Este desafio é da BossaBox que consiste em uma api para gerenciamento de ferramentas. Nesta api podemos Criar ferramentas com título, link (GitHub ou outras plataformas de hospedagem de repositórios), descrição e tags, além de outras funcionalidades.
Abaixo estão as features adiconadas a ferramentas e as que ainda serão implementadas:
- Usuário
- Cadastro:
- Login
- Atualização
- Deleção
- Ferramentas
- Cadastro de uma nova ferramenta
- Listagem de todas as ferramentas
- Listagem de ferramentas por tag
- Exclusão de ferramenta
- Atualização de uma ferramenta
Antes de começar você vai precisar ter instalados em sua máquiana as seguintes ferramentas: Git, Docker, Docker Compose e yarn.
O Insomnia é opcional, mas será mais fácil de utilizar a aplicação com ele.
Além disto é bom ter um editor para trabalhar com o código como VSCode
Renomeie o arquivo .env.example para .env
# Clone este repositório
$ git clone <https://github.com/ricciardi305/challenge-bossabox>
# Acesse a pasta do projeto no terminal/cmd
$ cd challenge-bossabox
# Instale as dependências
$ yarn install
# Execute o docker compose para iniciar a aplicação em um contêiner
$ docker-compose up
# Execute as migrações
$ docker exec tools_hub yarn typeorm migration:run -d src/data-source.ts
# O servidor iniciará na porta:3000 - acesse <http://localhost:3000/>Também disponibilizei um arquivo do insomnia para acessar a API aqui
Veja o arquivo package.json
Este projeto está sob a licença MIT License - Veja o arquivo License para mais detalhes.
Rafael Ricciardi
Feito com ❤️ por Rafael Ricciardi 👋🏽 Entre em contato!
