Helper library for running Node.js apps on VIP Go
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
__mocks__
__tests__
hooks
src
.eslintignore
.eslintrc
.gitignore
.npmignore
.publishrc
CONTRIBUTING.md
README.md
package-lock.json
package.json

README.md

VIP Go Node Helpers

This package provides modules to help run Node.js applications on VIP Go.

Modules

The following is a list of modules included in this package:

  • server: a server that wraps your request handler or express app behind an easy to use interface
  • logger: a ready to use logger for your node applications with Kibana integration out of the box
  • newrelic: New Relic integration for applications on VIP Go

Usage

const { server, logger, newrelic } = require( '@automattic/vip-go' );

Please refer the documentation for each module (server | logger | newrelic) to learn more about how to use it.

Development

Using hooks

For development, we have some hooks running before each commit/push. To use them, execute the following command inside the repo after cloning it:

git config core.hooksPath hooks