@pan-os/heimdall

Heimdall

An organizational and modular approach to handle pseudo microservices into restify applications.

Motivation

The whole idea behind this project is to allow you to manage your API using a structure easy to maintain and split into several packages, heimdall wants to transform your mindset to microservices and help you to keep everything in place.

Installation

Requirements

TBD

• Restify

Usage

/**
 * Module Dependencies
 */
const Heimdall = require('heimdall');
const { protect: withCerberus } = require('cerberus');
/**
 * Pseudo microservices
 */
const {
  terms, auth, config, user,
} = require('../services');

module.exports = (server) => {
  // Attach microservices to /
  Heimdall.attachMicroservice(server, auth);
  Heimdall.attachMicroservice(server, user);
  Heimdall.attachMicroservice(server, terms);
  Heimdall.attachMicroservice(server, withCerberus(config));
};

Development

$ yarn start:[env] (dev, prod)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT