PT Package DB Connections

Simple wrapper around many commonly used database connections with a few reusable constants included for consistency across different projects.

Prerequisites

• bumpversion - from here
• yarn - for package management

Installing

• Run yarn to install node_modules

Running the tests

This project uses mocha

• Invoke tests with yarn test
• They will be run automatically as pre-push hook through Husky
• You can use yarn coverage to check your code coverage

Coding style

This project enforces the Airbnb Javascript Style Guide

• Exceptions and modifications are shown in .eslintrc.js
• Linting and editor configuration is handled automatically through .editorconfig, .eslintrc.js and prettier.config.js
• Before committing your code, you should run yarn prettier to cleanup your code (although some linting will still be enforced on git commit)

Deployment

• This project is deployed under the Palletech scope to the NPM registry (manually)
• Please ensure all sensitive information/files are removed by including them in .npmignore