akera-devstudio

Akera-web Developer Studio component

Usage no npm install needed!

<script type="module">
  import akeraDevstudio from 'https://cdn.skypack.dev/akera-devstudio';
</script>

README

Akera Logo

Developer Studio module for Akera.io web service - provides a simple web interface for working with business logic procedures available on the application server.

Installation

$ npm install akera-devstudio

Docs

Quick Start

This module is designed to only be loaded as broker level service which is usually done by adding a reference to it in services section of each broker's configuration in akera-web.json configuration file.

  "brokers": [
    {	"name": "demo",
        "host": "localhost",
        "port": 3737,
        "services": [
            { 
                "middleware": "akera-devstudio",
                "config": {
                    "route": "/devstudio/"
                }
            }
        ]
    }
  ]

Service options available:

  • route: the route where the service is going to be mounted (default: '/devstudio/')

    This is a simple web user-interface that allows developers to edit or create new business procedures on application server web-path. Beside editing file's content some helpful functions are also available:

  • check syntax

  • compile, file or whole folder

  • run business logic procedures by passing any required input/output parameters

Dependencies

Although there is no direct dependency of those modules, in order to mount the developer studio on an application server web-service the following modules need to be mounted as well:

Important

Please note this module should NOT be enabled on production environment as it gives access to the file system on the application server which is a security risk.

License

MIT