Go to file
Drasko DRASKOVIC dd806d2a2e Update README.md 2015-10-10 00:55:04 +02:00
app Correct comments 2015-10-03 01:56:02 +02:00
config -- Hello docker-compose 2015-07-28 00:50:20 +02:00
.dockerignore Added Docker file 2015-07-26 23:39:09 +02:00
.gitignore Added Visual Studio files to .gitignore 2015-10-03 01:56:02 +02:00
CONTRIBUTING.md Switch LICENSE to Apache v2.0 2015-10-09 23:35:23 +02:00
Dockerfile Docker file fix 2015-07-28 01:10:32 +02:00
LICENSE Switch LICENSE to Apache v2.0 2015-10-09 23:35:23 +02:00
MAINTAINERS LICENSE, CONTRIBUTING and MAINTAINERS files 2015-10-04 05:10:45 +02:00
README.md Update README.md 2015-10-10 00:55:04 +02:00
docker-compose.yml -- Hello docker-compose 2015-07-28 00:50:20 +02:00
gulpfile.js -- Hello docker-compose 2015-07-28 00:50:20 +02:00
package.json -- Hello docker-compose 2015-07-28 00:50:20 +02:00
server.js Add device schema mock-up 2015-10-03 01:56:02 +02:00
swagger.yaml Initial commit 2015-07-06 22:32:02 +02:00

README.md

Mainflux

License Join the chat at https://gitter.im/Mainflux/mainflux

About

Mainflux is lean open source industrial IoT cloud written in NodeJS.

It allows device, user and application connections over various network protocols, like HTTP, MQTT, WebSocket and CoAP, making a seamless bridge between them. As a consequence, Mainflux represents highly secure and highly optimised M2M platform based on the cutting-edge standards and approaches in the industry.

Architecture

AltTxt

Features

An extensive (and incomplete) list of featureas includes:

  • Set of clean APIs, Swagger documented: HTTP RESTful, MQTT, WebSocket and CoAP
  • Set of client libraries for many HW platforms in several programming languages: C/C++, JavaScript and Python
  • Device management and provisioning and OTA FW updates
  • UNIX-like permissions for device sharing
  • Highly secured connections via TLS and DTLS
  • User authentication via JSON Web Tokens
  • Responsive and scalable ModgoDB database
  • Modern architecture based on micro-services
  • LwM2M standard compliance via Coreflux
  • Partial oneM2M compliance
  • Easy deployment and high system scalability via Docker images
  • Clear project roadmap, extensive development ecosystem and highly skilled developer community
  • Professional support via Mainflux company
  • And many more

Install

Clone the repo:

git clone https://github.com/Mainflux/mainflux.git
cd mainflux

Install Node modules:

npm install

Run Gulp Task:

gulp

Docker

Apart from main nodejs Docker image, Mainflux also uses mongo Docker image (database instance is run in a separte generic Docker image).

This is why Mainflux uses Docker Compose, to run both nodejs and mongo images at the same time and make a connection between them:

    docker-compose up

License

Apache License, version 2.0