@automattic/vip-go

Node package helpers for the VIP Go platform

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
645Jun 12, 2021Mar 15, 2018Minified + gzip package size for @automattic/vip-go in KB

Readme

VIP Go Node Helpers

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

Install

npm install --save @automattic/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
  • redis: a helper library to instantiate a Redis client compatible with VIP Go

Usage

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

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

New Relic is no longer a peer dependency of this module. Please remember to install New Relic separately if your app requires 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

Running tests

To run tests locally, make sure the Docker container is up and running:

docker-compose up

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.