portalnetwork / kaizen-cli

🌐🛠 Kaizen is a powerful framework combine all the blockchain technologies to help you easily develop and deploy dapps

KAIZEN CLI

One stop solution for dapp developers

| English | 한국어 | 中文 |

🚀 Overview

KAIZEN is an one stop solution for dapp and dweb developer. With KAIZEN, you get:

• Develop and manage multiple decentralized tech in one platform.
• Easily build your blockchain on popular cloud providers.
• Customize an existing blockchain to fulfill your requirements.

📚 Table of Contents

• Quick Start
• Examples
• Command Topics
• Dapp Templates
• Subgraph Templates
• Plugins
• Smart Contracts
• Instances
• Demo
• Community
• Contributing
• Licence

🚀 Quick Start

STEP 1. Install via npm:

npm install -g kaizen-cli 

STEP 2. Create a project:

kaizen create --template react --name myproject

STEP 3. Deploy smart contracts:

kaizen contracts deploy --url https://github.com/PortalNetwork/kaizen-contracts/tree/master/ERC20

STEP 4. Upload project to IPFS, BTFS or Swarm:

# Upload to IPFS
kaizen upload ipfs ./build
# or upload to BTFS
kaizen upload btfs ./build
# or upload to Swarm
kaizen upload swarm [file]

STEP 5. Hosting instance on AWS

kaizen instances run nym-loopix-mixnode

🔨 Command Topics

• kaizen config - Configure KAIZEN
• kaizen create - Create new KAIZEN project
• kaizen install - Install a KAIZEN project from GitHub
• kaizen upload - Upload a KAIZEN project
• kaizen plugins - Plugin management for KAIZEN
• kaizen instances - Instances management for KAIZEN
• kaizen contracts - Contract management for KAIZEN
• kaizen blockchains - Blockchain management for KAIZEN

Platform (Alpha)

The KAIZEN Platform is currently in experimental alpha.

• kaizen login - Login or sign up for the KAIZEN Platform
• kaizen logout - Logout from the KAIZEN Platform
• kaizen nodes - Node management of KAIZEN Platform

📦 Dapp Templates

• [React] - Dapp template make by react framework
• [Vue] - Dapp template make by vue framework
• [Plain-near] - Near protocol dapp template simple version
• [React-near] - Near protocol dapp template make by react

📦 Subgraph Templates

• [Subgraph] - Subgraph template, more information please visit here

🏗 Plugins

• Bluzelle - Decentralized database
• NKN - Data transmisstion
• ICON - Blockchain
• Orbit - Decentralized database
• Arweave - Decentralized file storage
• Fluence - Decentralized database
• Sia - Decentralized file storage
• NOIA - Decentralized CDN
• Near - Scalable decentralized application
• Tellor - Decentralized oracle service
• Skale - Elastic blockchain network
• Ren - Inter-blockchain liquidity for all decentralized applications
• Nervos - Multi-asset, store of value blockchain
• Kava - Cross-chain CDP platform for leverage assets
• Zabo - Multiple crypto wallet provider
• Loom - The Production-ready, Multichain Interop Platform for Serious Dapp Developers

⚙️ Instances

• NYM - Decentralized privacy
• Golem - Decentralized cloud computing

📑 Smart Contracts

• ERC20
• ERC721
• Chainlink
• Hopr
• Nucypher

🚰 Faucet

Join Faucet
Claim test net tokens, https://faucet.portal.network/:

• ETH
• ETC
• WAN
• ICON
• TRON
• TOMO
• QTUM

🔌 Demo

Nifty Game

• Nifty Game - Nifty is a non-fungible token game build by KAIZEN.

Dchat

• Dchat

💡 Community

• Gitter
• Twitter
• Facebook
• Reddit
• Telegram
• Medium

📣 Contributing

We love our contributors!

See CONTRIBUTING.md for how to help out.

Quick Start: Check out help wanted or good first issue labels to find issues we want to move forward on with your help.

📧 Contact

For any questions, please contact [email protected] or join telegram: http://bit.ly/2XjhQV2

🗒 Licence

See LICENSE for details.

kaizen-cli's Issues

Intergrate travis-ci

Checklist

• travis-ci

Deploy contracts using JSON keyfile + password

[Command] kaizen config set

Set config var

Command

kaizen config set --key PROVIDER --value https://mainnet.infura.io 

Show help command at first

Should show KAIZEN help by typing kaizen in cli

Compile and deploy local contracts

[Command] kaizen blockchains txresult

kaizen blockchains txresult will show the transaction receipt with the specified txhash

Command usage

kaizen blockchains txresult --blockchain <BLOCKCHAIN> --network <NETWORK> --txhash <TRANSACTION_HASH>

Get contract example from kaizen-contracts

Update KAIZEN image

• README.md
• README_KR.md
• README_ZH.md

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

An in-range update of progress is breaking the build 🚨

The dependency progress was updated from 2.0.1 to 2.0.2.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

progress is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

An in-range update of inquirer is breaking the build 🚨

The dependency inquirer was updated from 6.2.0 to 6.2.1.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

inquirer is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

[Command] kaizen contracts deploy

Deploy contracts through template or local contracts

Command usage

kaizen contracts deploy --template <URL> --private <PRIVATE_KEY>

[Command] kaizen plugin

Show plugin related information

kaizen plugins

Response command and description

kaizen plugins
kaizen plugins:install
kaizen plugins:uninstall
kaizen plugins:list

[Command] kaizen blockchains balance

kaizen blockchains balance will show the balance with the specified address

Command usage

kaizen blockchains balance --blockchain <BLOCKCHAIN> --network <NETWORK> --address <TRANSACTION_HASH>

[Command] kaizen config

This command will add configuration to kaizen

kaizen config --key <KEY> --value <VALUE>

kaizen contracts deploy should support local contract

[Command] kaizen contracts

Show contract commands

Command usage

kaizen contracts

[Command] kaizen upload

Upload project to IPFS or other else

Command usage

kaizen upload ipfs

modularize codebase and upload to npm

[Command] kaizen create

Create a kaizen project by using kaizen create

Command usage

kaizen create --template <TEMPLATE> --name <NAME>

[Command] kaizen install

Install a github repository by using kaizen install

Command usage

kaizen install --url <GITHUB>

[Command] kaizen blockchains list

kaizen blockchains list will show the list of support blockchains

Command usage

kaizen blockchains list

NOTICE The amount will be a limit

[Command] kaizen blockchains faucet

kaizen faucet can let user get the testnet token from the supported faucet

Command usage

kaizen faucet --name <NAME> --networkId <NETWORK_ID> --address <YOUR_ADDRESS> --amount <AMOUNT>

NOTICE The amount will be a limit

KAIZEN CLI

• kaizen init
• kaizen publish

integrate with KAIZEN manager

support Kaizen manager features

• create a project
• list projects
• project detail
• create an instance, e.g. ethereum, wanchain, or IPFS

"Kaizen plugin" command invalid

Seems that "kaizen plugin" is useless. Once I type it, there is nothing showing up on the terminal.

new boilerplate without any frameworks or libraries

In order to replace the original boilerplate which dependent on React or Vue that cause codebase hard to maintain and unfriendly use.

The new boilerplate build up without any frameworks or libraries like react, vue, and angular

This issue will be resolved at 4124c19 on PR #64

Download example from `kaizen install --url <github-url>`

This feature might be helpful to download any KAIZEN example from github

Support create wallet

Motivation

Using CLI to create wallet

Command

kaizen blockchains newaccount --blockchain <BLOCKCHAIN> 

[Command] kaizen config get

Display a single config value

Command usage

kaizen config get --key PROVIDER

[Command] kaizen plugin install

This command will install the plugin with specified name from the plugin list

kaizen plugin install <PLUGIN_NAME>

Requirement

Need check the specified kaizen.json and package.json

Network should have a common format

Motivation

kaizen blockchains have to specified networkId with integer format, but kaizen instances accept string, network should using a common format.

Effect Commands

kaizen blockchains faucet
kaizen blockchains tx
kaizen blockchains balance
kaizen instances deploy

If the node version is v9, it can not successfully run `npm run start` command

Describe the bug
The bug occurs when the node version is v9, and if the node version is v8, it can work as normal.

To Reproduce
Steps to reproduce the behavior:

1. $nvm use v9 switch to the v9 version of Node.js.
2. $npm install to install the packages.
3. $npm run start to start the development server.
4. It will stuck at the starting condition forever.

user authorized mechanism

In order to support the KAIZEN manager, KAIZEN CLI should have the user authorized mechanism to log in and log out KAIZEN manager.

[Command] kaizen plugin uninstall

This command will uninstall the plugin with specified name from kaizen.json and package.json

kaizen plugin uninstall <PLUGIN_NAME>

Requirement

Need check the specified kaizen.json and package.json

Integrate CI

Checklist

• CI integration

[Plugins] Add icon-sdk-js in to plugin list

Motivation

Support ICON development tools, icon-sdk-js

Effect Commands

# Should install icon-sdk-js
kaizen plugins install icon

# Should uninstall icon-sdk-js
kaizen plugins uninstall icon

# Should show the icon on the list
kaizen plugins list 

refactor react boilerplate

Refactor kaizen react's boilerplate to ensure it can work as expected

Iteration of command

• IPFS configuration setting locally
• IPFS upload should specify the path which user want to upload
• Ethereum configuration setting locally
• NKN configuration setting locally
• Improve 'kaizen add' command for better user experience

PR #64 , ba1bc1e, 2915e13, 267d0e8

Integration with Bluzelle

Add Bluzelle component with CRUD

Command error should response information

The error format can be implement like this

  Kaizen Error ---------------------------------------

  Kaizen command "hi" not found. Run "kaizen help" for a list of all available commands.

  Get Support --------------------------------------------
     Bugs:          github.com/PortalNetwork/kaizen-cli/issues

Get supported project install list from kaizen-examples

[Command] kaizen plugin list

Show all the plugin support by kaizen

kaizen plugin list

refactor kaizen command line

As KAIZEN CLI is integrating more services and functions, it is necessary to restructure its codebase. This issue is a list of things that has been updated and to be updated.

Below were completed in #43

• deprecate 'kaizen init'.
• deprecate 'kaizen plugin', and replace it with 'kaizen add --package'.
• new Bluzelle integrated library.
• new processing spinner animation

To be updated

• integrate with NOIA sdk
• update document

Refactor with new command structure

Reference: https://github.com/PortalNetwork/kaizen-cli/wiki/kaizen-cli

[Command] kaizen config unset

Unset config vars

Command usage

kaizen config unset --key PROVIDER

[Command] kaizen instances list

List all instance host on KAIZEN Platform

Command

kaizen instances list

Add React and Vue component

• NKN React component
• NKN Vue component

[Command] kaizen instances deploy

Deploy instance to KAIZEN Platform

Command

kaizen instances deploy --protocol <PROTOCOL> --network <NETWORK> --type <SHARED>