Code Monkey home page Code Monkey logo

ministream's Introduction

Ministream

Go Report Card license

Overview

Ministream is an open-source real-time data stream service. Ministream is well suited for event driven architectures.

Ministream is simple and straightforward, it runs on a single server and has no dependencies over third parties. Events records are pushed and pulled by a simple HTTP request. It it served by it's own HTTP(s) server and stores data on json files. Ministream can easily fit in a standalone docker container. Ministream also provides a complete web api to manage the server.

Quick install

Install the docker image

Use the official docker image: ghcr.io/nbigot/ministream:latest

Packages and versions

Install from the command line:

$ docker pull ghcr.io/nbigot/ministream:latest
$ docker run --name ministream -it -p 8080:8080 ghcr.io/nbigot/ministream:latest

Docker quick tips

The docker image ghcr.io/nbigot/ministream:latest is a multi-arch image that contains images for:

  • linux amd64 v2
  • linux amd64 v3
  • linux arm64
  • linux arm v7
$ docker manifest inspect ghcr.io/nbigot/ministream:latest

Install by building your own docker image

Download source code

$ git clone https://github.com/nbigot/ministream.git

Build a docker image

$ cd ministream
$ docker build -t nbigot/ministream .

Start a docker container

$ docker run --name ministream -it -p 8080:8080 nbigot/ministream

Install by compiling source code

Download source code

$ git clone https://github.com/nbigot/ministream.git

Compile

$ cd ministream
$ go build cmd/ministream/ministream.go

Configure

Edit the file config-templates/docker/config/config.yaml

Pay attention to the directory paths in the config file.

Run ministream

$ ministream -config config-templates/docker/config/config.yaml

Ministream quick tips

Let's assume Ministream is running and listening on the tcp port 8080.

Run simple commands:

$ curl http://localhost:8080
Welcome to ministream!

$ curl http://localhost:8080/api/v1/utils/ping
ok

Contribution guidelines

If you want to contribute to Ministream, be sure to review the code of conduct.

License

This software is licensed under the MIT.

ministream's People

Contributors

nbigot avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.