Este sistema servirá para gerenciar usuários.
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git e Node.js Além disto é bom ter um editor para trabalhar com o código como VSCode
💡A chave secreta de validação do token é uma palavra encriptada pelo MD5 Hash Generator.
💡As senhas de dados iniciais foram encriptada pelo Bcrypt-Generator.com.
💡Os tokens gerados pode ser validado pelo JWT.io.
💡O arquivo ".ENV" que aqui é orientado a ser criado é para ambiente de teste e utilização no docker, caso seja criado um ambiente manualmete crie as variáveis normalmente com os comando export no linux e set para windows com terminal ou cmd respectivamente.
💡 Para Windows utilize o git bash, para linux utilize o terminal normalmente.
### Criando a pasta do projeto.
$ mkdir api_node
### Entrando na pasta criada.
$ cd api_node
### Criar o arquivo "package.json".
$ npm init -y
### Gerencia as requisições, rotas e URLs, entre outra funcionalidades.
$ npm install express --save
### Habilitando o compartilhamento de recursos entre diferentes origens.
$ npm install cors --save
### Carregando variáveis de ambiente de um arquivo .env para process.env.
$ npm install dotenv --save
### Criando o arquivo que armazenará as variáveis necessárias para a aplicação executar.
$ touch .ENV
# Crie duas variáveis como mostra a seguir:
$ SERVER_URL='URL da api em produção.'
$ PORT='Porta da api em produção.'
### Trata as exceções de forma global.
$ npm install express-async-handler --save
### Produz código JS válido - para import do ES6.
$ npm install sucrase --save
### Reiniciar o servidor sempre que houver alteração no código fonte.
$ npm install -D nodemon --save
### Instalando ORM [Sequelize](https://sequelize.org/).
$ npm install sequelize --save
### Instalando o driver do Postgres.
$ npm install pg pg-hstore --save
### Instalando o driver do SQL Server
$ npm install tedious --save
### Apresenta os tipo de dados em tempo de execução
$ npm install reflect-metadata --save
# Crie um banco de dados e adicione ao arquivo .env na raiz do projeto as seguintes configurações:
$ DATABASE_DIALECT='dialect do seu banco de dados.'
$ DATABASE_NAME='Nome do banco de dados criado.'
$ DATABASE_HOST='Endereço IP do banco de dados.'
$ DATABASE_USERNAME='Usuário do banco de dados.'
$ DATABASE_PASSWORD='Senha do banco de dados.'
💡 As tabelas e os dados inicias da aplicação estão dentro das pastas /api_node/src/core/database/migraions e /api_node/src/core/database/seeders respectivamente.
# Criando uma Migration
$ npx sequelize migration:create --name=NOME_DO_ARQUIVVO_A_SER_GERADO
# Criando um Model
$ npx sequelize-cli model:generate --name NOME_DO_MODEL --attributes ATRIBUTO:TIPO
# Criando uma Seed
$ npx sequelize-cli seed:generate --name NOME_DO_ARQUIVVO_A_SER_GERADO
# Rodando as migrations.
$ npx sequelize db:migrate
# Rodando as seeders.
$ npx sequelize db:seed:all
### Apresenta os ENUMs dos status http.
$ npm install status-code-enum --save
### Constroi um arquivo de documentação utilizado pelo swagger.
$ npm install swagger-autogen --save
### Gera a visualização da documentação criada anteriormente.
$ npm install swagger-ui-express --save
### Gerando ducumentação swagger.
$ npm run swagger-autogen
### Criptografar a senha
$ npm install bcryptjs --save
### Validar requisições com JWT
$ npm install jsonwebtoken --save
# Adicione ao arquivo .env na raiz do projeto as seguintes configurações:
$ KEY_SECRET='Chave secreta encriptada pelo site mencionado no início das instruções.'
$ EXPIRES_IN='Tempo de expiração do token.'
### Envio de email
$ npm install nodemailer --save
# Adicione ao arquivo .env na raiz do projeto as seguintes configurações:
💡 Observação, para utilização do mailtrap não é necessário a propriedade (EMAIL_SSL)
$ EMAIL_SERVICE='Nome do serviço.'
$ EMAIL_HOST='Host do provedor.'
$ EMAIL_PORT='Porta do serviço.'
$ EMAIL_SSL='Utiliza SSL true/false.'
$ EMAIL_USER='E-mail de acesso ao email.'
$ EMAIL_PASSWORD='Senha de acesso ao email.'
💡 Caso deseje trabalhar com a aplicação com o TLS desabilitado coloque a proprieade como está abaixo:
$ NODE_TLS_REJECT_UNAUTHORIZED=false
### Multer é um middleware node.js para manipulação multipart/form-data, usado para o upload de arquivos.
$ npm install multer --save
### Se desejar utilizar o grant_type password do OAuth Adicione as propriedades abaixo no arquivo .env
$ CLIENT_ID='Nome de usuário para a autenticação da API.'
$ CLIENT_SECRET='Senha de usuário para a autenticação da API.'
# Se durante a geração das chaves(pública/privada) estiver utilizado senha adiciona a seguinte propriedade
$ PASSPHRASE='Senha da chave privada gerada'
#
$ openssl genrsa -out key_api_node.pem
#
$ openssl req -new -key key_api_node.pem -out csr_api_node.pem
#
$ openssl x509 -req -days 9999 -in csr_api_node.pem -signkey key_api_node.pem -out cert_api_node.pem
#
$ rm csr_api_node.pem
# Entrando no diretório
$ cd src/infrastructure/keys/
# Gerando chave privada
$ openssl genrsa -des3 -out token_key_private.pem 2048
# Adicionando o arquivo gerado no .gitignore
$ cat src/infrastructure/keys/token_key_private.pem >> .gitignore
# Gerando chave pública a partir da chave privada gerada anteriormente
$ openssl rsa -in token_key_private.pem -outform PEM -pubout -out token_key_public.pem
# Adicionando o arquivo gerado no .gitignore
$ cat src/infrastructure/keys/token_key_public.pem >> .gitignore
# Visualizando chave gerada
$ less token_key_private.pem
### Baixando o projeto
$ git clone https://github.com/srgeverson/api_node
### Entrando na pasta criada.
$ cd api_node
### Instalando as dependências.
$ npm install
### Iniciando a aplicação em modo de produção.
$ npm start
$ docker-compose up -d
### Iniciando a aplicação em modo de desenvolvimento.
$ npm run development
### Gerando ducumentação swagger
$ npm run swagger-autogen
$ npx sequelize-cli init
### URL da documentação em desenvolvimento
$ http://localhost:8080/api-docs
$ https://localhost:8081/api-docs