⛔ [DEPRECATED] muban-core

⚠️ This version will not receive any future updates, there is a new version

The muban repository and muban-core package will not receive any future updates.

There is a new version in active development at github.com/mubanjs (also called v2), with modern features and a full ecosystem for storybook, testing, hooks, etc.

This package contains the core library and webpack loaders for Muban. Please have a look at the main repo for more information.

Installation

yarn add muban-core

Building

In order to build muban-core, ensure that you have Git and Node.js installed.

Clone a copy of the repo:

git clone https://github.com/mediamonks/muban-core.git

Change to the muban-core directory:

cd muban-core

Install dev dependencies:

yarn

Use one of the following main scripts:

yarn build            # build this project
yarn dev              # run compilers in watch mode, both for babel and typescript
yarn test             # run the unit tests incl coverage
yarn test:dev         # run the unit tests in watch mode
yarn lint             # run eslint and tslint on this project
yarn doc              # generate typedoc documentation

When installing this module, it adds a pre-commit hook, that runs lint and prettier commands before committing, so you can be sure that everything checks out.

Contribute

View CONTRIBUTING.md

Changelog

View CHANGELOG.md

Authors

View AUTHORS.md

LICENSE

MIT © MediaMonks