TECHNICAL_DESIGN.md

Technical Design

Guide for the implementation, including detailed design, priorities, coding conventions, and testing

Code structure

• src: Typescript source code

• test: Jest unit tests

• script: Folder for bash, python or ts-node scripts

• dist: Temporary folder for building distribution code

• report: Temporary folder for reporting; usually for continuous integration

• .github: Folder for github pipeline

• .vscode: Folder for visual code snippets

Useful links

• Guideline for Clean Code in Typescript

• Supporting node.js ESM