https://github.com/natura-cosmeticos/node-base

The Node Base offers an easier way to implement the coding practices recommended by Natura Architecture Team
https://github.com/natura-cosmeticos/node-base

Last synced: 3 months ago
JSON representation

The Node Base offers an easier way to implement the coding practices recommended by Natura Architecture Team

• Host: GitHub
• URL: https://github.com/natura-cosmeticos/node-base
• Owner: natura-cosmeticos
• License: isc
• Created: 2018-12-05T19:28:25.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-24T20:31:00.000Z (10 months ago)
• Last Synced: 2024-04-25T14:29:38.596Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.72 MB
• Stars: 7
• Watchers: 9
• Forks: 12
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-base

[![Known Vulnerabilities](https://snyk.io/test/github/natura-cosmeticos/node-base/badge.svg)](https://snyk.io/test/github/natura-cosmeticos/node-base)

[![Build Status](https://api.travis-ci.org/natura-cosmeticos/node-base.svg?branch=master)](https://travis-ci.org/natura-cosmeticos/node-base)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/9ee01fcbab76443393f4e01d9711cf6f)](https://www.codacy.com/app/fabricioffc/node-base?utm_source=github.com&utm_medium=referral&utm_content=natura-cosmeticos/node-base&utm_campaign=Badge_Grade)

## What for

The Node Base offers an easier way to implement the coding practices recommended by Natura Architecture Team.

## What it's included

* Docker environment

* Isomorphic code, capable to run in local environment, lambda and kubernetes

* Logging using the structure recommended

  * Logger module supporting with correlation id, session id, etc

  * Logging middleware to log input and output data

  * TypeORM logger module using the logger module

* Tests helpers to improve productivity

* Abstraction to use code practices recommended

  * Base Command to create events based commands

  * Express Handler to create the interface between your domain and the Express

  * Environment variables from AWS SSM

* Debug mode for development and tests

## How to contribute

You can contribute submitting [pull requests](https://github.com/natura-cosmeticos/node-base/pulls).

### Setup

Run `npm install`.

### Testing

Just run `npm test`.

### Lint

To verify if any lint rule was broken run: `npm run lint`.

### Update docs

Run `npm run docs` to generate a new documentation version.