Blackrik

Contents

• What is Blackrik?
• Getting Started
  • Installation
  • Usage
• Documentation
• How to contribute
• License

What is Blackrik?

Blackrik is a CQRS and Event-Sourcing Framework for Node.js.

Stuff to read

• CQRS - A pattern for a separated write (command) and read (query) side
• Event-Sourcing - An approach where every state change of an application is stored in an event
• Aggregates - A pattern to encapsulate associated states, commands and events (for more information see Domain Driven Design)
• More

Getting Started

Installation

Make sure you have at least Node.js v14.0.0 installed

$ node --version
v14.0.0

Create a new project (or use an existing one)

$ mkdir hello-world
$ cd hello-world
$ npm init -y

Then install the Blackrik module

$ npm i blackrik

Usage

const Blackrik = require('blackrik');
const config = require('./config');

const blackrik = new Blackrik(config);
blackrik.start()
    .then(() => console.log('Blackrik started...'));

Check out the examples to learn how everything works together.

Documentation

Read the documentation.
See config for details about the config.

How to contribute

Please check the CONTRIBUTING.md for details.

License

Copyright (c) 2021, wesone

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.