https://github.com/jpommerening/ci-relay

Tiny CI status aggregation service built on top of ci-adapter and ci-router
https://github.com/jpommerening/ci-relay

Last synced: 24 days ago
JSON representation

Tiny CI status aggregation service built on top of ci-adapter and ci-router

• Host: GitHub
• URL: https://github.com/jpommerening/ci-relay
• Owner: jpommerening
• Created: 2015-12-04T12:56:41.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-15T11:00:09.000Z (almost 9 years ago)
• Last Synced: 2024-04-14T15:48:53.936Z (7 months ago)
• Language: JavaScript
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ci-relay

> Tiny CI status aggregation service built on top of [ci-adapter][] and [ci-router][]

## Install

To install the required dependencies, you need `npm`:

```console

$ npm install

```

## Setup

Have a look at the [`config-example.json`](config-example.json) file. Copy it

to `config.json` and replace the defaults with something meaningful.

If left blank, the `port` and `host` configuration options will use the

`$PORT` and `$HOST` environment variables, defaulting to `localhost:3100`

if unspecified.

The example configuration serves the CI status of:

- [Buildbot](http://buildbot.buildbot.net) on `/buildbot`

- [Jenkins](https://ci.jenkins-ci.org) on `/jenkins`

- [Travis-CI](https://travis-ci.org/travis-ci) on `/travis`

For detailed information on available adapter options refer to [ci-adapter][].

## Start

Once the configuration and dependencies are in place, just type:

```console

$ npm start

```

_That's it!_  Your CI API should now be running on [http://localhost:3100](http://localhost:3100) (or the port

you specified in your configuration).

[ci-adapter]: https://github.com/jpommerening/ci-adapter

[ci-router]: https://github.com/jpommerening/ci-router