Project Structure
Viewing typescript
switch to python
Moose 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 Moose project:
- models.ts
- SourceModel__DestinationModel.ts
- aggregation.ts
- dataApi.ts
- 1.firstTask.ts
- 2.secondTask.ts
- config.toml
- package.json
- moose.config.toml
- openapi.yaml
- models.py
- SourceModel__DestinationModel.py
- aggregation.py
- data_api.py
- 1.first_task.py
- 2.second_task.py
- config.toml
- moose.config.toml
Top-level Folders and Files
| app | The main folder for your application. |
| .moose | Moose internals. Your auto-generated project documentation is stored here. |
| package.json | The default npm package manifest file |
| moose.config.toml | Configuration file specific to Moose for your application. |
App folders
| datamodels | The folder where you define your Data Models. |
| functions | The folder where you define your Streaming Functions |
| blocks | The folder where you define your Blocks |
| apis | The folder where you define your Consumption APIs |
| scripts | The folder where you define your Workflows |