ismaelalvesgit / node-express-example

Este projeto foi criado para motivos acadêmicos para minha aprendizagem pessoal utilizando Node.js e Express.

Ambiente de EXEMPLO para express.js

Este projeto foi criado para motivos acadêmicos para minha aprendizagem pessoal utilizando Node.js e Express.

Feramentas Utilizadas:

• NodeJs
• Express
• knex
• mysql2
• dotenv
• cors
• joi
• date-fns
• date-fns-tz
• helmet
• hide-powered-by
• http-status-codes
• morgan
• swagger-jsdoc
• swagger-ui-express
• uuid
• winston
• winston-daily-rotate-file
• x-xss-protection
• yamljs
• ioredis
• amqplib
• ramda
• i18n
• googleapis
• nodemailer
• archiver
• compression
• connect-multiparty
• mv
• rimraf
• shelljs
• exceljs
• docx
• html-pdf
• zipkin
• socket.io
• nodemon

Screenshots

App view:

Development

Setup

1) Instalação de dependencias

npm i 

Obs: E necessario que o NodeJs já esteja instalado em sua máquina

2) Data base

docker-compose up -d 

Obs: Deixei uma aquivo de DockerCompose para que a utilização deste projeto seja mais simples

3) Migrate Knex

npm run migrate:up

4) Iniciar Projeto

npm run dev

# verificar a url http://localhost:3000 ou http://localhost:${customPort}

5) Uso

Faça 2 request na rota http://localhost:3000 ou http://localhost:${customPort} e verifique o seu console de execução

EXTRA

1) Base de dados

Antes de iniciar qual ambiente sejá ele LOCAL | DOCKERIZADO deve ser criado uma base de dados no mysql uma para o ambiente de DEV. Para mais informações veirifique ./src/env.js para as variaveis de ambiente verifirifique .env.example

Database Name	User Database	Password Database
example	root	admin

2) Documentação

O projeto possui uma documentação das rotas da API basta navegar para http://localhost:3000/api-doc, tambem deixei um arquivo localicado ./docker-compose.prod.yml para facilitar os teste teste projeto.

3) Criar nova migrate

Rode o comando

set NAME=teste && npm run migrate:create

4) Email Config

Estarei deixando o link do appMenosSeguro que necessita estar habilitado para utilização do serviço de envio de email padrão. Para utilizar os serviços de email com OAuth2 siga os proximos passo link.

Contato

Desenvolvido por: Ismael Alves

• Email: [e-mail]
• Github: github.com/ismaelalvesgit
• Linkedin: linkedin.com/in/ismael-alves-6945531a0/

Customização de Configurações do projeto

Verifique Configurações e Referencias.