README

wolkenkit-application

wolkenkit-application manages wolkenkit applications on disk.

Installation

$ npm install wolkenkit-application

Quick start

First you need to add a reference to wolkenkit-application in your application:

const applicationManager = require('wolkenkit-application');

Validating an application

To validate an application, call the application manager's validate function and specify the fully qualified directory name of the wolkenkit application you want to validate:

try {
  await applicationManager.validate({ directory: '...' });
} catch (ex) {
  // ...
}

Please note that this only validates whether the required directories and files are there, but that it doesn't say anything about whether the files have the correct code structure.

Loading an application

To load an application, call the application manager's load function and specify the fully qualified directory name of the wolkenkit application you want to load:

const application = await applicationManager.load({ directory: '...' });

Now you can get the application's configuration by using the configuration.readModel, configuration.writeModel and configuration.flows properties:

console.log(app.configuration.readModel);
// => {
//      lists: {
//        peerGroups: {}
//      }
//    }

Alternatively, if you need access to the source code of the application, use the readModel, writeModel and flows properties instead.

Running the build

To build this module use roboter.

$ npx roboter

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see GNU Licenses.

Usage no npm install needed!