Skip to content
develop
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Neuron

Nervos CKB Desktop Wallet

Azure Pipelines Build Status 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.

$ yarn global add lerna # install lerna globally

Install Dependencies

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

$ yarn bootstrap

Start Neuron

As of v0.26.0, Neuron bundles a CKB binary and starts it for Mainnet automatically. If you prefer to run a local CKB node yourself instead, please follow the Nervos CKB doc to get it up and running before launching Neuron.

Note: If you run CKB node on Windows but it fails to start, you may need to download and install the latest Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019.

Start Neuron in Development Mode

$ ./scripts/download-ckb.sh # Download CKB binary for your platform. Neuron will starts it automatically.
$ yarn start

This command starts neuron-ui, the React UI layer and neuron-wallet, 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

$ 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.