@iftt/demo-backend v1.3.10

demo-backend

About

This is an example implementation of services and devices on the IOTA network using a weather station, FPGA, and a garage door opener. The IOTA network is still a young protocol with a lot of room for interpretation on how to best utilize it. While there have been attempts to market data for financial gain, I believe the more practical application lies in the sale of IoT devices with an ASIC POW chip to talk on the IOTA network effortlessly.

This demo server is essentially a means of managing devices and how they interact with the IOTA tangle.

Install

# yarn
yarn add @iftt/demo-backend
# npm
npm i --save @iftt/demo-backend

How to use

Create Environment file

create a file called .env with these keys and replacing the variables:

PORT=3001
JWT_SECRET=m7ugp0jKc4RoRJvXtnCJrETheIRZENay
JWT_EXPIRES=15d
WEATHER_API=00000000bec84a09aa12094c4b3eac071c733dbc80834fc5a8d02fe840000000
WEATHER_APP_API=000000005ac24e28a5d6f76bb4b710c4fa5c76f1129b4002905afe31c0000000
WEATHER_TANGLE_SEED=I9XZHZETFFDYRWISYGGONGSULUTERQXQYZRALTNXWXQMRIORUSTTCKJVYNHCBWKGSDVEKIBXMQMOJKPQBX

How to generate a unique JWT secret

# Linux
cat /dev/urandom |tr -dc a-zA-Z0-9|head -c${1:-32}
# OS X
cat /dev/urandom |LC_ALL=C tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1

How to generate a unique IOTA seed

# Linux
cat /dev/urandom |tr -dc A-Z9|head -c${1:-81}
# OS X
cat /dev/urandom |LC_ALL=C tr -dc 'A-Z9' | fold -w 81 | head -n 1

Create the NodeJS server

Option 1: download this repository and run from the lib

# clone the repo
git clone https://github.com/iftt/demo-backend.git
# install dependences
yarn # or npm install
# run the server
yarn run server  # npm run server

Option 2: install the npm package and run

After installing the package, create a JS file and input the following

// ES6
import '@iftt/demo-backend'
// ES5
require('@iftt/demo-backend')

Modules

These are some of the main modules that make up the IFTT project:

module	tests	version	description
demo-backend			IFTT Server (this module)
tryte-encode-decode			data<-->trytes
tryte-buffer			json<-->Trytes
program-generator			create programs from user defined json
icc-fpga-protocol			POW with an fpga device
garage-client			open/close garage with IOTA tangle

ISC License (ISC)

Copyright 2019 Copyright (c) 2004-2010 by Internet Systems Consortium, Inc. ("ISC") Copyright (c) 1995-2003 by Internet Software Consortium

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.