Getting Started
Project Structure

Project Structure

MooseJS relies heavily on structural conventions to make sure you can build quickly and reliably. That means the project structure is important.

The following is the basic structure of a MooseJS project:

      • models.ts
      • sourceModel__destinationModel.ts
      • aggregation.ts
      • data-api.ts
  • package.json
  • moose.config.toml
  • Top-level Folders and Files

    appThe main folder for your application.
    .mooseMoose internals. You shouldn't ever have to touch anything in here.
    package.jsonThe default npm package manifest file (opens in a new tab)
    moose.config.tomlConfiguration file specific to Moose for your application.

    App folders

    datamodelsThe folder where you define your Data Models.
    functionsThe folder where you define your Streaming Functions - note that the hierarchy of folders here dictates the routing and orchestration of your streaming functions.
    aggregationsThe folder where you define your Aggregations
    apisThe folder where you define your Consumption APIs