# nodejs-starter

**Repository Path**: hummerstudio/nodejs-starter

## Basic Information

- **Project Name**: nodejs-starter
- **Description**: ocp demo nodejs sample
A simple Hello World Node.js application
- **Primary Language**: NodeJS
- **License**: EPL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-04-01
- **Last Updated**: 2022-04-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# nodejs-starter

This is a sample starter project that provides you with a basic Express app and a sample test in a `/test` sub directory. This sample project uses `Express v4.17.x` and enables health checking and application metrics out of the box. You can override or enhance the following endpoints by configuring your own health checks in your application.

## Health checking

Health-checking enables the cloud platform to determine the `readiness` and `liveness` of your application.

 These endpoints will be available for you to use:

- Readiness endpoint: http://localhost:3000/ready
- Liveness endpoint: http://localhost:3000/live

## Application metrics

The [prom-client](https://www.npmjs.com/package/prom-client) module will collect a wide range of resource-centric (CPU, memory) and application-centric (HTTP request responsiveness) metrics from your application, and then expose them as multi-dimensional time-series data through an application endpoint for Prometheus to scrape and aggregate.

 This endpoints will be available for you to use:

- Metrics endpoint: http://localhost:3000/metrics

## License

This stack is licensed under the [EPL 2.0](./LICENSE) license.