Skip to content

Latest commit

 

History

History
29 lines (17 loc) · 1.95 KB

File metadata and controls

29 lines (17 loc) · 1.95 KB

Developer guide

This project is based on PDK and additional tools linked below. It's advised to familiarise with them before diving too deep in the source code:

Project definition

Any change to the project structure, dependencies and/or their configuration must be applied in the code by changing the projen files defined by this accelerator. The entry point is the .projenrc file located in the root folder which referes to classes that are located in the projenrc folder.

Any change to the project structure requires you to run pnpm projen from the root folder to apply the changes.

API Definition

Any change to the API definition (payload, structure) must be applied to the Web API Service package using Smithy model, which leverages typesafe API from PDK to generates documentation and runtime to be used in the application.

Optimization Engine

To apply changes to the optimization engine it's advised to refer to the timefold documentation. This accelerator uses the linear optimization solver library as foundation to build the optimization engine.

Infra

The infrastructure (IaC) is done with CDK and the entry point is the infra-app main file. This project includes other packages (e.g. API, optimization engine, routing etc.) as dependencies and deploy altogether in your AWS Account.

Instructions on the deployment can be found in the infra-app README file