cortex.iot

A automation and logging stack

Usage no npm install needed!

<script type="module">
  import cortexIot from 'https://cdn.skypack.dev/cortex.iot';
</script>

README

Cortex.iot

Environment logging and hardware automation for the masses.

Available Versions:

State Version Number Github link NPM CLI
Current Release Version: pre-alpha 0.6.1 Github N/A
Current Dev. Version: pre-alpha 0.7.2+ Github npm i cortex.iot

How To Install

Download and install node.js
# create a folder you would like to install your cortex.environment
# open a terminal in this folder or cd there from your terminal

# firts we need to initialize the node environment
# you can press enter for all options. 
# cortex.iot will overide all settings
$ npm init

# now we can install cortex.iot
$ npm i cortext.iot

# if we look inside our folder we will see only a 3 things.
# node_modules, packages, and package-lock
# To continue we need to generate the cortex.iot environment

# To generate Cortex.iot cd into its node_modules location
$ cd node_modules/cortex.iot

# From here we can generate cortex.iot
$ npm run generate

# Once Complete we can go back to the project directory
$ cd ../../

# Crongratz you have installed your first cortex.iot environment
# now to run cortex.iot simply run the command bellow
$ npm run quick_deploy

Access Offline Documentation & Quick Deployment Tooling

Cortex.iot comes with an offline docs so you will always have the most up to date version.

Cortex.iot also comes with a Quick Deployment Tool that will allow you to build the json device bank shape to quick deploy any cortex.iot environment.

# From the root of your cortex.iot environment
$ npm run docs

# navigate to your browser:
http://localhost:9000/

http://localhost:9000/ is cortex.iot.docs is the entire documentation. You will also find a link to Quick Deployement Tool => http://localhost:900/quick

Quick Deployment Tooling

Quick Deployment Tool will allow users to predefined cortex.iot environments in an offline environment.