An open API service indexing awesome lists of open source software.

https://github.com/nickforddev/rafipayment_socket_server

Websockets server for deployment notices
https://github.com/nickforddev/rafipayment_socket_server

Last synced: over 1 year ago
JSON representation

Websockets server for deployment notices

Awesome Lists containing this project

README

          

# Rafipayment Websockets Server

[![Build](https://travis-ci.org/TheRafiApp/rafipayment_socket_server.svg?branch=master)](#)
[![Coverage Status](https://coveralls.io/repos/github/TheRafiApp/rafipayment_socket_server/badge.svg?branch=master)](https://coveralls.io/github/TheRafiApp/rafipayment_socket_server?branch=master)
[![Maintainability](https://api.codeclimate.com/v1/badges/83c75db1633e5d045364/maintainability)](https://codeclimate.com/github/TheRafiApp/rafipayment_socket_server/maintainability)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

Websockets server to watch for deployments and alert users, built with node and [engine.io](https://github.com/socketio/engine.io)

## Development

It is possible to run using `export NODE_ENV=dev && npm start`, but better to run in Docker

```
docker-compose -f docker-compose.dev.yml up --build
```

## Deployment

Uses `post-receive` git hook to rebuild the container using `docker-compose`

## Tests

Jest unit tests

```
npm test
```