@kong-fu-panda/kangaroo

Kangaroo

Kangaroo is a state management pattern + library mimic Vuex. It serves as a centralized store for all the components in an application, with rules ensuring that the state can only be mutated in a predictable fashion.

Recommended Editor

It is highly suggested to use Visual Studio Code as it is extendible and light weight.

The project comes configured with some settings that make development within vscode as simple as possible.

These include things such as code format on save and debugging current ts files and tests.

Npm Scripts

• npm run lint: Lint all typescript files.
• npm run format: Format all ts files in the src folder.
• npm run commit: Commit using commitzen to ensure commits follow the correct convention.
• npm run test: Run all jest tests on files that end with *.spec.ts in the test folder.
• npm run cov: Generate and open a test coverage report using jest.
• npm run cov:open: Open the generated test coverage report.
• npm run doc: Generate and open documentation using typedoc.
• npm run doc:open: Open generated documentation.
• npm run build: Build the project using the typescript compiler.
• npm run version: Generate or update a CHANGELOG.md, bump the package version and create a tag using Standard Version.