Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2.75 KB

README.md

File metadata and controls

56 lines (35 loc) · 2.75 KB
Raw

msgflo-project Greenkeeper badge Build Status Docker Hub x86 Docker Hub Raspberry Pi3

This repository provides a template for creating and running new MsgFlo projects.

Features

  • Support for JavaScript components
  • Support for CoffeeScript components
  • Support for Python 3 components
  • docker-compose runnable environment

Getting started

  • Fork this repository and name it to whatever suits your purpose
  • Update the project name and repository details accordingly in package.json
  • If you need additional libraries, add them to package.json (for Node.js) or requirements.txt (for Python 3)

You can use this template for development both with a direct installation or with Docker.

Running locally

  • Install and start a Mosquitto message broker
  • Install the Node.js dependencies of this project with npm install
  • Install the Python 3 dependencies of this project with pip3 install -r requirements.txt
  • Start the MsgFlo broker with MSGFLO_BROKER=mqtt://localhost npm start

Running with Docker

  • Ensure you have a running Docker daemon
  • Start the project with docker-compose up (use docker-compose-raspberrypi3.yml file if you want to run on RPi3)

Note: by default the MsgFlo coordinator and MQTT ports are only available on localhost. Edit the ports declarations in docker-compose.yml if you want to open them to the outside.

Editing in Flowhub

Everything is set up so that you can edit the project in Flowhub

Once you've installed and started the service either locally or with Docker, open Flowhub with:

http://app.flowhub.io#runtime/endpoint?protocol%3Dwebsocket%26address%3Dws%3A%2F%2Flocalhost%3A3569

You should see an empty graph. Click Edit as project to start hacking!

Use Flowhub's GitHub synchronization feature to push your graph and component changes to your repository.

Test automation

  • Enable your local fork in Travis CI
  • Tests are written in fbp-spec format and located in spec/ folder
  • You can run tests locally with npm test (note: you'll have to do npm install for this even when running with Docker)

Changes

  • 1.0.0 (git master)
    • Switched from Python 2 to Python 3