Skip to main content

Solution creation

In this section, we will learn how to initialise an ELARA project. For more detailed documentation see the CLI Reference.

Installation#

The EDK is a public npm package containing a command-line interface, api, and development libraries. The following guide demonstrates how to install the EDK to start developing an ELARA solution.

Create a project#

Once installed, the CLI can be invoked from the command line. For example, to read the CLI help, run:

$ edk helpUsage: edk [options] [command]
Options:  -h, --help                     display help for command
Commands:  init [options]                 initialise a new ELARA project  add                            add an asset to the project  remove [options] <asset>       remove an asset from the project  links [options] <asset>        show the directly linked assets in a project  list [options]                 list the assets in the project  update [options]               update the assets in the project  build [options]                build the schema from assets  deploy [options] <deployment>  deploy the assets in a project  help [command]                 display help for command

For now, we will create an empty project using the edk init command:

$ edk init --name='Example Business'

Project directory structure#

The edk init will produce a workspace folder where generated source code and schema files can be added later. The basic directory structure is as follows:

example_businessβ”‚   elara.json|   schema.json|   package.json|   tsconfig.json└───genβ”‚   β”‚   ... generated schematic files will go here ...β”‚   β”‚   ...β”‚   ││└───srcβ”‚   β”‚   ... elara definition files will go here ...β”‚   β”‚   ...β”‚   β”‚β”‚   ...

We now have an empty project that we will use to build the working example. The next step is understand the key concepts of how ELARA defines the various solution components within the enterprise schema.