Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/kwiesmueller/roomsync

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/kwiesmueller/roomsync
Owner: kwiesmueller
License: gpl-3.0
Created: 2018-02-19T02:02:27.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2018-02-19T02:07:24.000Z (almost 7 years ago)
Last Synced: 2024-10-28T19:50:58.243Z (about 2 months ago)
Language: Go
Size: 743 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# roomsync
[![Go Report Card](https://goreportcard.com/badge/github.com/kwiesmueller/roomsync)](https://goreportcard.com/report/github.com/kwiesmueller/roomsync)
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Build Status](https://travis-ci.org/kwiesmueller/roomsync.svg?branch=master)](https://travis-ci.org/kwiesmueller/roomsync)
[![Docker Repository on Quay](https://quay.io/repository/kwiesmueller/roomsync/status "Docker Repository on Quay")](https://quay.io/repository/kwiesmueller/roomsync)

Integration for various chat solutions to sync their messages for defined rooms

## Description

### Planed Features

### Assumptions

## Dependencies
This project has a pretty complex Makefile and therefore requires `make`.

Go Version: 1.8

Install all further requirements by running `make deps`

## Usage

```
roomsync
```

## Development

This project is using a [basic template](github.com/playnet-public/gocmd-template) for developing PlayNet command-line tools. Refer to this template for further information and usage docs.
The Makefile is configurable to some extent by providing variables at the top.
Any further changes should be thought of carefully as they might brake CI/CD compatibility.

One project might contain multiple tools whose main packages reside under `cmd`. Other packages like libraries go into the `pkg` directory.
Single projects can be handled by calling `make toolname maketarget` like for example:
```
make template dev
```
All tools at once can be handled by calling `make full maketarget` like for example:
```
make full build
```
Build output is being sent to `./build/`.

If you only package one tool this might seam slightly redundant but this is meant to provide consistence over all projects.
To simplify this, you can simply call `make maketarget` when only one tool is located beneath `cmd`. If there are more than one, this won't do anything (including not return 1) so be careful.

## Contributions

Pull Requests and Issue Reports are welcome.
If you are interested in contributing, feel free to [get in touch](https://discord.gg/WbrXWJB)