Go to file
Dejan Mijić d5b913d432 MF-199 - Create documentation skeleton (#218)
* Copy basic docs contents to the main repo

Signed-off-by: Dejan Mijic <dejan@mainflux.com>

* Include licensing and contributing info to docs

Signed-off-by: Dejan Mijic <dejan@mainflux.com>

* Create documentation skeleton

Signed-off-by: Dejan Mijic <dejan@mainflux.com>
2018-04-08 23:03:12 +02:00
.github MF-199 - Create documentation skeleton (#218) 2018-04-08 23:03:12 +02:00
cmd MF-174 - Add logger interface and go-kit logger implementation (#212) 2018-04-04 10:15:23 +02:00
coap Add protobuf (#192) 2018-03-19 10:14:43 +01:00
docker Add CA cert (#215) 2018-04-04 02:29:29 +02:00
docs MF-199 - Create documentation skeleton (#218) 2018-04-08 23:03:12 +02:00
http MF-174 - Add logger interface and go-kit logger implementation (#212) 2018-04-04 10:15:23 +02:00
logger MF-174 - Add logger interface and go-kit logger implementation (#212) 2018-04-04 10:15:23 +02:00
manager MF-170 - Add manager API unit tests (#211) 2018-04-08 22:57:56 +02:00
normalizer MF-174 - Add logger interface and go-kit logger implementation (#212) 2018-04-04 10:15:23 +02:00
vendor Add protobuf (#192) 2018-03-19 10:14:43 +01:00
.gitignore MF-199 - Create documentation skeleton (#218) 2018-04-08 23:03:12 +02:00
Gopkg.lock Add protobuf (#192) 2018-03-19 10:14:43 +01:00
Gopkg.toml Add protobuf (#192) 2018-03-19 10:14:43 +01:00
LICENSE MF-199 - Create documentation skeleton (#218) 2018-04-08 23:03:12 +02:00
MAINTAINERS Remove lora-related artifacts 2017-09-22 23:17:04 +02:00
Makefile Simplify Makefile (#205) 2018-03-22 13:10:11 +01:00
README.md MF-199 - Create documentation skeleton (#218) 2018-04-08 23:03:12 +02:00
doc.go Use PostgreSQL as primary persistence solution (#175) 2018-03-11 18:06:01 +01:00
message.proto Add protobuf (#192) 2018-03-19 10:14:43 +01:00
mkdocs.yml MF-199 - Create documentation skeleton (#218) 2018-04-08 23:03:12 +02:00
publisher.go Add protobuf (#192) 2018-03-19 10:14:43 +01:00
utils.go Use PostgreSQL as primary persistence solution (#175) 2018-03-11 18:06:01 +01:00
version.go Fix golint warnings (#189) 2018-03-16 14:06:12 +01:00

README.md

Mainflux

build go report card coverage license chat

banner

Mainflux is modern, scalable, secure open source and patent-free IoT cloud platform written in Go.

It accepts user, device, and application connections over various network protocols (i.e. HTTP, MQTT, WebSocket, CoAP), thus making a seamless bridge between them. It is used as the IoT middleware for building complex IoT solutions.

For more details, check out the official documentation.

Features

  • Protocol bridging (i.e. HTTP, MQTT, WebSocket, CoAP)
  • Device management and provisioning
  • Fine-grained access control
  • Platform logging and instrumentation support
  • Container-based deployment using Docker

Quickstart

Before proceeding, install the following prerequisites:

Once everything is installed, execute the following commands from project root:

cd docker/
docker-compose up -f docker/docker-compose.yml -d

Contributing

Thank you for your interest in Mainflux and wish to contribute!

  1. Take a look at our open issues.
  2. Checkout the contribution guide to learn more about our style and conventions.
  3. Make your changes compatible to our workflow.

Community