RC-BOX

A React table data manipulator / wrapper for TS/JS projects!

WARNING: This project is currently under development, use with your own risk!

Installation

To install the latest version:

$ npm install --save-dev rc-box

Most likely you'll also need the Immutable.js library.

$ npm install --save-dev immutable

Documentation

Read the docs!

Contributing

If you'd like to contribute to rc-box, you'll need to run the following commands to get your environment set up:

$ git clone https://github.com/zhenwenc/rc-box.git
$ cd rc-box                  # go to the rc-box directory
$ npm install               # install local npm build / test dependencies

# Available scripts:

$ npm run typings-install   # install external type definitions
$ npm run build             # compile typescript source code
$ npm run test              # run all unit test suits
$ npm run watch:test        # watch for source / test file changes
$ npm run docs              # generate documentation files

npm run watch:test will watch for changes in the /src/ and /test/ directory, compile the source files when a change occurs. The output files are written to the /dist/ directory. It will also re-run the unit tests every time you update any source files.

License

RC-BOX is MIT-licensed.