Skip to content
This repository was archived by the owner on May 12, 2019. It is now read-only.

mrprompt/queroumaloja-api

Repository files navigation

Quero Uma Loja - API

Build Status for Master Code Climate Test Coverage Issue Count GitHub issues GitHub stars GitHub license Known Vulnerabilities

API de Produtos.

Deploy

Pré Requisitos

Instalação

Antes de rodar aplicação, são necessárias configurações das variáveis de ambiente - valores entre parênteses é o padrão:

NODE_IP (127.0.0.1)
NODE_PORT (8080)
MONGODB_URI (localhost:27017)
PASSWORD_SALT ($2a$10$MeVpoT66x6r2eNFZ8diZDe)

Você pode criar um arquivo ".env" no diretório raiz do projeto com as variáveis de ambiente. O arquivo é ignorado pelo git.

Logo após tudo configurado, basta instalar as dependências

npm install

Após a instalação, é necessário criar a estrutura básica do banco, então, rode o comando de instalação:

node ./bin/install

Feito isso, você pode rodar a API e acessar o endereço com o mesmo nome do seu host - talvez seja necessário editar o registro no banco para atualizar com o endereço correto. Bastando editar a coleção sites.

Rodando

npm start

Testes

Para os testes unitários, é utilizado o Mocha.

npm test

Garantia

Esta API é disponibilizada como está, o autor não é responsável por qualquer perda ou dano consequente da utilização desta. Você tem total liberdade de instalá-la em seu próprio servidor e utilizar para quaisquer fins, com ou sem modificações na mesma.

Contribuindo

Esta é uma API de código aberto e livre, fique a vontade para fazer um fork e contribuir com qualquer melhoria ou solução de bugs que a mesma possua ou precise.

Gerando um password salt

Para gerar um salt para o password, você pode executar o arquivo de exemplo da própria biblioteca bcrypt e utilizar alguma das várias saídas geradas (você precisará dar um Ctrl+C para finalizar o script).

node node_modules/bcrypt/examples/forever_gen_salt.js

Documentação

A documentação é gerada utilizando o utilitário apidoc e você pode conferir aqui:

./node_modules/.bin/apidoc -o apidoc -i routers/

About

API de Produtos

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •