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
npm i
Obs: E necessario que o NodeJs já esteja instalado em sua máquina
docker-compose up -d
Obs: Deixei uma aquivo de DockerCompose para que a utilização deste projeto seja mais simples
npm run migrate:up
npm run dev
# verificar a url http://localhost:3000 ou http://localhost:${customPort}
Faça 2 request na rota http://localhost:3000 ou http://localhost:${customPort} e verifique o seu console de execução
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 |
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.
Rode o comando
set NAME=teste && npm run migrate:create
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.
Desenvolvido por: Ismael Alves
- Email: [email protected]
- Github: github.com/ismaelalvesgit
- Linkedin: linkedin.com/in/ismael-alves-6945531a0/
Verifique Configurações e Referencias.