Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/uniqys/UniqysKit

Uniqys Kit - A toolkit for creating your own DApps
https://github.com/uniqys/UniqysKit

blockchain dapp uniqys uniqys-kit

Last synced: about 2 months ago
JSON representation

Uniqys Kit - A toolkit for creating your own DApps

Awesome Lists containing this project

README

        

# Uniqys Kit


Uniqys Kit logo

[![CircleCI](https://circleci.com/gh/uniqys/UniqysKit.svg?style=svg)](https://circleci.com/gh/uniqys/UniqysKit)
[![Build Status](https://dev.azure.com/Uniqys/UniqysKit/_apis/build/status/uniqys.UniqysKit?branchName=master)](https://dev.azure.com/Uniqys/UniqysKit/_build/latest?definitionId=1&branchName=master)

**WARNING:** Uniqys Kit is still in beta version, and we may still make some breaking changes.

Uniqys Kit is a framework for building Decentralized Applications (or DApps).
It is designed for web developers to easily build DApps; just like you always build your web app.

For details, visit our [project website](https://uniqys.net/kit) and [documentation](https://uniqys.github.io/UniqysKitDocs/).

Also, feedbacks are appreciated via GitHub issues, [Gitter](https://gitter.im/uniqys/UniqysKit), or [Twitter](https://twitter.com/uniqys).

## Introduction

Uniqys Kit has two main components:

- Chain Core: Builds and manages a blockchain on a Tendermint consensus algorithm.
- Easy Framework: A framework for developers to create DApps without being aware of the blockchain.

These two packages were designed to remove some of the current obstacles in creating or using DApps.

### TL;DR

- Chain Core establishes an application-friendly blockchain network.
- **Scalable:** Creates a single blockchain for every single DApp.
- **Fast:** Instant finality and high transaction throughput are obtained with the Tendermint algorithm.
- **Flexible:** Developers can decide the most suitable transaction fees and incentives to the network maintainer.
- Easy Framework achieves "DApp development ≒ Web app development".
- Building a REST API and a frontend is all you need to do to develop a DApp.
- No programming language restriction.
- Data storing on blockchain can be done with using a pre-existing Memcached library.
- Sending a transaction is sending a signed HTTP request.
- Track external events (i.e. Ethereum Events) in the blockchain network so that it can become a side chain.

### How Does It Work?

Please check our [documentation](https://uniqys.github.io/UniqysKitDocs/).

## Getting Started

### Installing via npm

```sh
$ npm install -g @uniqys/cli
```

### Creating a DApp

Check our [Get Started documentation](https://uniqys.github.io/UniqysKitDocs/introduction/get-started.html) for instruction.

## Building

### Setup for [nodenv](https://github.com/nodenv/nodenv)

```sh
$ nodenv install
```

### Install

```sh
$ npm ci
# This project is created as monorepo. Bootstrap runs automatically after install.
```

### Build

```sh
$ npm run build
```

### Test

```sh
$ npm test
```

### Trying Samples

After building Uniqys Kit, please see the [packages/samples directory](packages/samples/) to try our samples.

## License

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

Please refer to `LICENSE` file under each package.