Coder Social home page Coder Social logo

abelsouzacosta / authentication_module Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 162 KB

This is a simple authentication module build with nodejs, typescript, jwt, typeorm and express

License: MIT License

TypeScript 97.78% Handlebars 2.22%
multer password-reset authentication authorization nodemailer

authentication_module's Introduction

Aut

Essa é uma api de autenticação baseada em papeis e permissões para o usuário.

Tecnologias utilizadas

Usando a api

  1. Primeiramente faça o clone do repositório para a sua máquina
git clone [email protected]:abelsouzacosta/authentication_module.git

cd authentication_module
  1. Insale as dependências
# instalando as dependências
yarn or npm install
  1. Usando as variáveis de ambiente

A api faz uso de variáveis de ambiente, essas variáveis são definidas em dois arquivos distintos .env onde são guardadas as variáveis de ambiente referentes ao servidor e ormconfig.env que guarda as variáveis de ambiente referentes ao banco de dados da aplicação, assim sendo renomeie os arquivos .env.example e ormconfig.env.example para .env e ormconfig.env respectivamente

Dentro do seu .env determine a porta da aplicação e o hash do jwt

# Porta do servidor da aplicação
PORT =

# Hash do JWT
SECRET =

Dentro de seu ormconfig.env devem estar as seguintes configurações

# Tipo de banco de dados utilizado
TYPEORM_CONNECTION = (postgres, mysql, sqlite...)

# Host do banco de dados
TYPEORM_HOST =

# Username do banco de dados
TYPEORM_USERNAME =

# Senha do banco
TYPEORM_PASSWORD =

# Nome do banco
TYPEORM_DATABASE =

# Porta do banco de dados
TYPEORM_PORT =

### As variáveis abaixo não devem ser modificadas ###

# Padrão das migrations
TYPEORM_MIGRATIONS = ./src/shared/typeorm/migrations/*.ts

# Diretório onde devem ser criadas as migrations com o comando `typeorm migration:create`
TYPEORM_MIGRATIONS_DIR = ./src/shared/typeorm/migrations

# Diretórios onde serão encontradas as entidades
TYPEORM_ENTITIES = ./src/modules/**/typeorm/entities/*.ts
  1. Crie as tabelas no banco de dados

Execute as migrations

yarn typeorm migration:run

Banco de dados

O banco de dados dessa aplicação está disposto como no diagrama abaixo:

demonstration

Endpoints

Você pode baixar o ambiente de rotas dessa api clicando no botão abaixo:

Run in Insomnia}

authentication_module's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.