Almin.js Build Status

Almin.js logo

Sauce Test Status

Flux/CQRS patterns for JavaScript application.

Write code thinking :)

Why?

Now, We can implement web applications with Flux or Redux etc...

But, I often hear a story that "Control flow of Flux/Redux is cool, but where to implement domain logic."

I think that people skip to Flux/Redux from MV* pattern.

MV* --> ( HOLE ) --> Flux/Redux(CQRS+EventSourcing)

Almin.js aim to fill the HOLE between MV* and Flux/Redux.

Features

Almin provides some patterns, is not a framework.

  • Testable
  • Scalable
  • Responsibility Layers patten - well-known as DDD(Domain-Driven Design)/CQRS
  • Support TypeScript and Flow

Almin is an implementation of Read/Write Stack Architecture that is well-known as Flux/CQRS.

Installation

npm install almin

You'll also need a Promise polyfill for older browsers.

npm install es6-promise

Usage

:memo: Please See https://almin.js.org/ for details.

What is Almin?

Almin provides Flux/CQRS patterns for JavaScript applications.

It aims to create a scalable app.

Overview of almin-architecture

The above figure is overview of Almin architecture that is similar to CQRS(Command Query Responsibility Segregation).

But, Almin is not a framework, provides only these components

  • Dispatcher
  • Context
  • UseCase
  • Store
  • StoreGroup

Other components like Domain, Repository and State are written by you!

Of course, Almin help you to write other components.

Also, You may notice that these components are similar to Flux architecture.

Almin is also a flux implementation library. :thumbsup:

Almin Flux Redux
Dispatcher Dispatcher store.dispatch
Context Container Middleware/React Redux
UseCase ActionCreator Actions
Store Store Store
StoreGroup Container combineReducers
(State) Store Reducer
(Domain)
(Repository)

:memo: State, Domain and Repository is optional on Almin, because the best for these components is vary based on application.

Almin has not a perfect solution for an application, but we can write code thinking.

We are going to learn two architectures(Flux/CQRS) using Almin :)

Table of Contents

Truly Table of Contents is here :arrow_left:

Examples

Real Examples

Welcome to pull request!

Running Tests

Running Tests in Node.js

npm test

Running Tests in Browser

npm run test:browser

Running Tests in Sauce Labs

# Need "~/.zuulrc" for using Sauce Labs
npm run test:saucelabs

Building Docs

API Reference is generated from source codes.

npm run build:docs:api

Preview documents by GitBook.

npm run build:docs
# preview
npm run start:docs

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

License

MIT

results matching ""

    No results matching ""