This site or product includes IP2Location LITE data available from https://lite.ip2location.com.

EXAMPLE environment for express.js

This project was created for have a init project with all the configuration for ... using Node.js and Express.

Tools Used:

• 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
• ramda
• i18n
• socket.io
• nodemon
• prom-client

Development

Setup

1) Installation of dependencies

npm i

Note: It is necessary that NodeJs is already installed on your machine

2) Base date

docker-compose up -d

Note: I left a file of DockerCompose so that the use of this design is simpler brew cask install docker

sudo curl -L "https://github.com/docker/compose/releases/download/1.25.4/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose sudo chmod +x /usr/local/bin/docker-compose

3) Setup Data base and Initial Data

npm run setup:up

4) Start Project

npm run dev

# check the url http://localhost:3000 or http://localhost:${customPort}

5) Usage

Make 2 requests on the route http://localhost:3000 or http://localhost:${customPort} and check your execution console

EXTRA

1) Database

Before starting which environment it is LOCAL | DOCKERIZADO must be created a database in mysql one for the DEV environment. For more information check ./src/env.js for environment variables check .env.example

Database Name	User Database	Password Database
finance	root	admin

2) Documentation

The project has a documentation of API routes, just navigate to http://localhost:3000/api-doc, I also left a localized file ./docker-compose.prod.yml to make testing project easier.

3) Create new migrate

run the command

set NAME=test && npm run migrate:create

4) Email Config

I'll be leaving the link to appMenosSeguro that needs to be enabled to use the standard email sending service. To use email services with OAuth2 follow the next steps check the pdf in doc to follow the steps. https://console.cloud.google.com/home/dashboard?project=everythink-ea1cd https://developers.google.com/oauthplayground/

5) Postman Collection

I will be leaving a collection of the tool Postman to facilitate manual testing. 😁😁😁

Contact

Developed by: Matias Baglieri 🤓🤓🤓

• Email: matiasbaglieri@gmail.com
• Github: github.com/d0bl3c3r0
• Linkedin: linkedin.com/in/rebelus/

Project Settings Customization

Check Settings and References.

---

License

You can check out the full license here

This project is licensed under the terms of the PRIVATE license.