API Basico em Nodejs

Trata-se de uma API que contem o basico para o inicio de um projeto.

Essa API contem o login utilizando JWT (JSON Web Token), o cadastro de usuário simples com nome, email e senha, permissões de ADMIN ou USER e trabalha com banco de dados postgres.

Instalação

OS X & Linux OR Windows:

> cd /Api-nodejs-init-project
> yarn

Configuração para Desenvolvimento

Feito a instalação com o yarn, só o que precisamos fazer agora é setar os arquivos de configuração:

Dentro do arquivo ~/src/config/auth.js.

export  default {
  secret:  '698dc19d489c4e4db73e28a713eab07b', // Random String MD5
  expiresIn:  '1d' // Quantidade de Tempo para Expirar o Token
};

Dentro do arquivo ~/src/config/database.js.

module.exports  = {
  username:  "root", // Usuário do Banco de Dados
  password:  "password", // Senha do Banco de Dados
  database:  "dbname", // Nome do Banco de Dados
  host:  "127.0.0.1", // Ip da maquina que esta rodando Banco de Dados
  dialect:  "postgres",
  define: {
    timestamps:  true,
    underscored:  true,
    underscoredAll:  true
  }
};

Utilização

Depois de instalado e configurado agora só falta mais alguns passos para se utilizar a API.

Abra o terminal e entre na pasta do projeto
Execute o comando

> yarn dev

Abra o browser na url http://localhost:3333/api se tudo tiver configurado corretamente irá aparecer como a imagem abaixo:

Histórico de lançamentos

0.0.1
- Versão inicial

Contribuição

Faça o fork do projeto (https://github.com/diogofelizardo/Api-nodejs-init-project/fork)
Crie uma branch para sua modificação (git checkout -b feature/new)
Faça o commit (git commit -am 'Add some new Feature')
Push (git push origin feature/new)
Crie um novo Pull Request