https://github.com/protolambda/redapp
Redux web3 integration and util for DApps
https://github.com/protolambda/redapp
Last synced: about 2 months ago
JSON representation
Redux web3 integration and util for DApps
- Host: GitHub
- URL: https://github.com/protolambda/redapp
- Owner: protolambda
- License: mit
- Created: 2018-07-09T20:11:33.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-10T11:49:54.000Z (over 6 years ago)
- Last Synced: 2023-12-19T17:12:52.358Z (over 1 year ago)
- Language: JavaScript
- Size: 1.17 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ReDApp
[](https://travis-ci.org/protolambda/redapp)
[](https://david-dm.org/protolambda/redapp)
[](https://david-dm.org/protolambda/redapp?type=dev)
[](https://opensource.org/licenses/MIT)
ReDApp is a NPM package aiming to ease the development of DApps (decentralized applications)
by performing the common web3 tasks in an idiomatic [Redux](https://github.com/reduxjs/redux) flow:
- call smartcontract getters, e.g. read token balance.
- transactions
- accounts
- blocks
- send regular transactions
- send smart-contract transactions
coming soon in V2:
- retrieve history: get filtered event logs
ReDApp only supports Web3.js v1.0+.
## Documentation
API reference docs and integration docs can be found here:
[ReDApp Documentation](https://redapp.protolambda.com)
## Dependencies
### Library deps.
- Web3.0, v1.0+
- redux + redux-saga: where tracked information is maintained and updated with.
- UUID/v4: for unique ids for each transaction. Hashes do not suffice since in-broadcast transactions don't have a hash yet.
### Dev deps.
- Babel (v7): ES6 support
- Mocha, Chai: testing
- istanbul: coverage reporting
- rimraf, cross-env, npm-run-all: utils for npm run scripts
- ESLint: linting
- ESdoc: documentation generator, checks doc coverage.
## Examples
See `/examples` folder:
- [ReDApp React example](examples/react-example/README.md)
- [Minimal example](examples/simple)
## Testing & Coverage
```bash
npm run:test
npm run:cover
```
## Building
There are three build output formats: ES6, common-js, UMD.
### ES6
- Babel stage features are transformed, code is otherwise the same
- Separate modules
- Outputs to `es`
```bash
npm run build:es
```
### Common-js
- Separate modules
- Compatible with non-ES6 code
- Outputs to `/lib`
```bash
npm run build:cjs
```
### UMD
- bundled code, single module require.
- Built to work with unpkg.
- external dependencies
- external babel helpers (`regeneratorRuntime`)
- Outputs to `/dist/redapp.js`, and a minified version, `/dist/redapp.js`
```bash
npm run build:umd
npm run build:umd:min
```
## License
MIT, see [LICENSE file](LICENSE)