https://github.com/kochie/guardian-server

Server for communicating with guardian hosts.
https://github.com/kochie/guardian-server

Last synced: 5 months ago
JSON representation

Server for communicating with guardian hosts.

• Host: GitHub
• URL: https://github.com/kochie/guardian-server
• Owner: kochie
• License: apache-2.0
• Created: 2017-08-11T00:09:19.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2018-03-06T23:37:37.000Z (over 8 years ago)
• Last Synced: 2024-11-20T14:47:47.660Z (over 1 year ago)
• Language: Go
• Size: 114 KB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# guardian-server [![Build Status](https://travis-ci.org/kochie/guardian-server.svg?branch=master)](https://travis-ci.org/kochie/guardian-server) [![Coverage Status](https://coveralls.io/repos/github/kochie/guardian-server/badge.svg?branch=master)](https://coveralls.io/github/kochie/guardian-server?branch=master)

Server for communicating with guardian hosts.

# Building and Installation

The project can be build on either docker or bare metal, however most development is done with the provided dockerfile.

## Bare Metal

- Clone the repository.

```bash

git clone git@github.com:kochie/guardian-server.git

```

- Start a [redis](https:/redis.io) instance somewhere and take note of the connection settings.

- Start a [postgres](https://www.postgresql.org/) database somewhere and take note of the connection settings as well.

- Modify the environment variables found in `config.json` and update any settings required.

- Build the service with go, normally a sequence like.

```bash

go test -v ./...

go build main.go

```

- [Optionally] Install the binary.

```bash

go install main.go

```

## Docker

To build in docker compose.

```bash

docker-compose build 

```

To run in docker compose.

```bash

docker-compose up

```