VUTTR (Very Useful Tools to Remember) é um simples repositório para gerenciar ferramentas com seus respectivos nomes, links, descrições e tags.
O que você precisa para instalar o software:
Node v10.15.x
Caso deseje, você poderá usar os comandos equivalentes no NPM
Recomenda-se instalação via docker com o comando abaixo:
docker run --name postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres
Recomenda-se instalação via docker com o comando abaixo:
docker run --name redis -p 6379:6379 -d -t redis:alpine
As etapas abaixo ajudarão você a instalar e configurar o VUTTR corretamente
git clone https://github.com/lucassoaresaraujo/vuttr.git
Dentro da pasta do projeto rode o seguinte comando:
yarn
No postgres, crie o banco de dados para aplicação
Na raiz do projeto, crie um novo arquivo chamado .env e copie o conteúdo do arquivo .env.example para dentro dele.
Ajuste as configuraçes do Postgres e Redis, por exemplo:
# Database
DB_HOST=localhost
DB_USER=postgres
DB_PASS=docker
DB_NAME=<insira aqui o nome do banco de dados criado no passo anterior>
DB_PORT=5432
# REDIS
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
yarn sequelize db:migrate
yarn dev
yarn build
yarn start
Certifique-se de possuir o Redis instalado e configurado no arquivo .env.test:
#REDIS
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
Execute o seguinte comando para realizar os testes:
yarn test
Para realizar os testes, certifique-se que o servidor não esteja iniciado
O arquivo
/__tests__/coverage/lcov-report/index.htmlpossui detalhamentos da cobertura dos testes
No diretório docsencontra-se o arquivo index.html com a documentaço da API.
Em ambiente de desenvolvimento você poderá acessá-la através do seguinte endereço:
http://localhost:3000/
Para alterar a documentação utilize o arquivo '/docs/api.apib'.
Para atualizar o arquivo
/docs/index.htmlinstale o Aglio e, dentro do diretóriodocs, execute o seguinte comando:aglio -i api.apib --theme-full-width --no-theme-condense -o index.html