@ords/core
    TypeScript icon, indicating that this package has built-in type declarations

    0.16.3 • Public • Published

    This project builds a modular microservice architecture in typescript.

    UNDER DEVELOPMENT! - Needs a repository with an example implementation, some of the links are not working yet!

    Gitter Channel

    Chat in Gitter

    Architecture

    Illustrated in the figure below is a database (module) microservice who registers at the server ServiceRegistry. A connector module recives and requests and sends back responses to a client where a map maps the request to a specfic microservice such as the database microservice. Eventually resolvers is gonna be added to the ServiceRegistry so that microservices can be resolved with other than local methods etc webhooks.

    drawioArchitecture

    Using this module

    This module exists on npm. To use it run:

    npm install @ords/core --save
    

    The module includes ShortenAct the purpose of this is to simplify calls made to the ServiceRegistry.

    Global dependencies

    • nodejs
    • typescript
    • typings
    • mocha

    Getting started

    Initially install dependencies by running:

    npm run build-env
    

    Whenever you have made changes you can run the following command

    npm run build-depoly
    

    Scripts

    In order to test the project you can now run:

    npm test
    

    To clean the project do:

    npm run clean
    

    Contribution

    Contributions can be made to either modules (microservices), maps or this repo. Module and maps contribution is managed in http://github.com/medsolve/ords-modules and http://github.com/medsolve/ords-maps resspectivly.

    Core modules implements proposals from the proposals directory. Essentially all kinds of modules can be delivered but modules following the proposals will be entirely interopable. Below are general rules for code contribution:

    • Use camleCase instead of underscore for namespace, variables and functions
    • constants CAPITALIZED
    • Interfaces, Abstract, Classes, Types all with conventional naming starting with a capital letter
    • Document your code with comments
    • Write at least unit tests
    • Follow established directory structure

    Variables or anything named with a _ prefix is usually instanciated automaticly somewhere in the core a module and should therefore not be manipulated. An example is the _meta property that is attacted to the Request as a microservices is carried out.

    Versioning

    We use schemantic versioning. We do no introduce backwards compatible breakable code without upgrading the software version to a major release.

    Todo

    • More documentation
    • Better tests
    • Update website for project
    • Example implemetation

    Install

    npm i @ords/core

    DownloadsWeekly Downloads

    27

    Version

    0.16.3

    License

    MIT

    Last publish

    Collaborators

    • runekongsgaard