https://github.com/automattic/vip-go-node

Helper library for running Node.js apps on VIP Go
https://github.com/automattic/vip-go-node

vip-go

Last synced: 3 months ago
JSON representation

Helper library for running Node.js apps on VIP Go

• Host: GitHub
• URL: https://github.com/automattic/vip-go-node
• Owner: Automattic
• Created: 2018-03-15T21:56:54.000Z (almost 7 years ago)
• Default Branch: trunk
• Last Pushed: 2024-06-18T15:27:10.000Z (6 months ago)
• Last Synced: 2024-10-07T11:16:12.036Z (3 months ago)
• Topics: vip-go
• Language: JavaScript
• Homepage: https://wpvip.com
• Size: 2.7 MB
• Stars: 9
• Watchers: 8
• Forks: 5
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

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](https://github.com/Automattic/vip-go-node/tree/trunk/src/server): a server that wraps your request handler or `express` app behind an easy to use interface

- [logger](https://github.com/Automattic/vip-go-node/tree/trunk/src/logger): a ready to use logger for your node applications with Kibana integration out of the box

- [newrelic](https://github.com/Automattic/vip-go-node/tree/trunk/src/newrelic): New Relic integration for applications on VIP Go

- [redis](https://github.com/Automattic/vip-go-node/tree/trunk/src/redis): a helper library to instantiate a Redis client compatible with VIP Go

## Usage

```js

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

```

Please refer the documentation for each module ([`server`](https://github.com/Automattic/vip-go-node/blob/trunk/src/server/README.md) | [`logger`](https://github.com/Automattic/vip-go-node/blob/trunk/src/logger/README.md) | [`newrelic`](https://github.com/Automattic/vip-go-node/blob/trunk/src/newrelic/README.md)) | [redis](https://github.com/Automattic/vip-go-node/tree/trunk/src/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](https://docs.newrelic.com/docs/agents/manage-apm-agents/installation/install-agent) 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

```