Uniqys Kit - Create your dapp in Uniqys Network
Switch branches/tags
Nothing to show
Clone or download
Latest commit 2ae9f63 Dec 10, 2018

README.md

Uniqys Kit logo

Uniqys Kit: A blockchain platform for DApps

CircleCI

Uniqys Kit is a developer-friendly toolkit to create scalable DApps in Uniqys Network. Uniqys Kit has two main components: Chain Core and Easy Framework.

  • Chain Core provides fast and scalable blockchain infrastructure by using the sidechain technology.
  • Easy Framework enables developers to create DApps without being conscious of the blockchain.

For details, please visit our website and documentation.

Current status

This is a beta version of Uniqys Kit, and it is still under development. It is ready for building a blockchain and is able to take consensus to maintain a sole application state in the network.

We would appreciate if you could give us your feedback via GitHub issue, Gitter, or Twitter.

Chain Core

chain-core-dev package is removed, and chain-core package is available. chain-core implements Tendermint consensus algorithm and thereby it can construct a secure blockchain network. It only supports static validator set, and dynamic validator set will be implemented in the future version.

Easy Framework

Easy Framework is ready for developers to use, and it now provides you necessary data for building DApps (i.e. timestamp, block hash).

Getting started

Setup for ndenv

$ ndenv install v10.9.0

Install

📝 This project is created as monorepo. You must run bootstrap before building Uniqys Kit.

$ npm install
$ npm run bootstrap

Build

$ npm run build

Test

$ npm test

Try Samples

After building Uniqys Kit, please see packages/samples directory.

Create Your DApp

Please check our documentation for instruction. To see our examples, please refer to packages/samples.

Building a DApp with Uniqys Kit is mostly as simple as building a modern web application.

  • To implement a server-side API, use Memcached (with permanent data storage) for the database. You can use the existing memcached library.
  • To implement a frontend, use Easy Client for accessing your server-side API. Consider Easy Client as an HTTP client library (like Axios) with features to sign a transaction.

License

License for each package in Uniqys Kit is different. Some packages are under the Apache License Version 2.0, and the other packages are under the Mozilla Public License Version 2.0.

Please refer to LICENSE under each package.