/raid

Centralised state container

Primary LanguageJavaScript

Raid

De/Centralised state container

v6 now better supports single or multiple signals. Build your app how you want!

npm License: MIT Build Status Coverage Status Dependency Status js-standard-style

Getting Started

Install with yarn or npm

yarn add raid
npm i -S raid

Quick Start

Raid has a complementary create-raid-app package that will scaffold out a project ready to start raiding.

mkdir my-awesome-project
npm i -g create-raid-app
create-raid-app
npm start -- -o

You can also scaffold using npx

npx create-raid-app

Examples

The Raid codebase has been written to encourage collaboration and uses lerna to implement a monorepo. To hook dependencies up correctly prefer yarn over npm.

To get going you can let lerna do the heavy lifting; clone the repository, install the root dependencies and then let lerna hook things together by running the setup script.

To fire in to the examples run yarn start after letting lerna hook things up. This is also a live development environment and will automatically reload the browser when there are changes to any of the packages.

yarn
yarn run setup
yarn start

Running tests

yarn
yarn run setup
yarn test

Contributing

Pull requests are always welcome, the project uses the standard code style. Please run yarn test to ensure all tests are passing and add tests for any new features or updates.

For bugs and feature requests, please create an issue.

License

MIT