search

LeastAuthority / nervos-neuron

MIT License
0 stars 0 forks source link

readme

Neuron

Nervos CKB Desktop Wallet

Azure Pipelines Build Status TravisCI Telegram Group

Quick Start

Prerequisites

You will need node >= 12 and yarn >= 1.14 to build and run Neuron.

Lerna

This project uses lerna for package management. It can be installed either globally or locally within the project:

$ yarn global add lerna # install lerna globally
# or
$ yarn add lerna --exact --ignore-workspace-root-check # install lerna locally within the project

Install Dependencies

After lerna has been installed, run this to install and link dependencies:

$ yarn bootstrap

Start Neuron

A local CKB node is required for Neuron wallet to talk to it via RPC APIs and get data. Please follow the Nervos CKB doc to get CKB node up and running first.

Start Neuron in Development Mode

$ yarn start

This command will start two tasks:

  1. start neuron-ui, which is the React UI layer.
  2. start neuron-wallet, which is the core wallet layer.

You can also start them independently:

# start neuron-ui at `http://localhost:3000`
$ yarn start:ui
# start neuron-wallet
$ yarn start:wallet

Test

# launch the test runner.
$ yarn test

Download Neuron Binary

If you don't want to bother building from source, you can download a binary from releases. We offer pre-built binaries for Windows, Linux and macOS.

License

Neuron is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.