@simeap/operand-common v1.0.1

n3C.2 : operaNd:Algorithms

FLINT Architecture > operaNd Module

Overview

This project contains the implementation details for all Algorithms' component of operaNd module within FLINT architecture. Algorithms component scope focuses on a set of problem-solving operations and/or calculations to serve the rest of FLINT's module via gRPC.

Development Reference Guide

This document is a "Getting Started" guide to assist a developer to setup a consistent environmnent to jump start Algorithms component development work quickly. There are scuffolding structure and reference tamplate in place to bootstrap the onboarding process.

Toolchains

One of the FLINT architecture objective is to reduce the vast dependency on plugins, third party libraries and/or addons to maintain process simplicity and output consistency in a complex distributed development environment.

• Main Tools:
  • Node 12.16.~ (LTS) & npm 6.13.~
  • Emscripten SDK (get the latest from github)
• Dev Dependencies:
  • file-loader@5.1.0
  • ts-loader@6.2.1
  • typescript@3.8.3
  • webpack@4.42.0
  • webpack-cli@3.3.11
  • webpack-node-externals@1.7.2

• Dependencies:

  • @grpc/proto-loader@0.5.3
  • dotenv@8.2.0
  • grpc@1.24.2
  • module-alias@2.2.2

  NOTE: General development standard and practices and/or a guide to install/setup a particular tools, refer to n3000 : FLINT - Standard Toolchain Reference Guide. This information given in this guide is specific to this project.

Folder Structure & Files

The codes is organize in the following folder structure, <componentGroupFolder> is a logical group of codes according to a domain or functionality. It can have multilayer sub-folder depending on the complexity of a domain/function, the final deployment bundle will be ONE package per project.

  ./dist
  ./build
  ./test
  ./src
    ../<component 1>
      ../<sub component 1.1>
    ../<component 2>
      ../<sub component 2.1>
      ../<sub component 2.2>
    ../<component 3>
  package.json
  tsconfig.json
  webpack.config.js

Component Overview

Calculations

Common

Crytogaphies

Information

PRoduction Rules