npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ords/core

v0.16.3

Published

Microservice architecture with service proposals in nodejs and typescript

Downloads

19

Readme

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