Neuron: Get Started on Windows

Neuron: Get Started on Windows

Preparations

Neuron is an official CKB wallet and an open source project on github, so it’s recommended that install Git for Windows and the following steps are performed on Git Bash.

• Install Git and open Git Bash

Download Git for Windows on Git-Downloads，double-click to install it and open Git Bash.

Install prerequisites

You will need node >= 11 and yarn >= 1.12 to build and run this Neuron.

Install node

Download the latest version on Download|Node.js, double-click to install it, set the path and environment variables after installation.

Install yarn

Download the latest stable version on install|Yarn, double-click to install it, set the path and environment variables after installation.

Check out the code from GitHub

open Git Bash and clone source code from github.

`$ git clone https://github.com/nervosnetwork/neuron.git
$ cd neuron`

Install Lerna

Neuron project uses lerna for packages management. It can be installed globally, or locally in the project.

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

Install Dependencies

After lerna installed, the dependencies can be installed by

$ yarn bootstrap

Start Neuron

Start Neuron in development mode

$ yarn start

[Image: image.png] This command will start two tasks

1. start neuron-ui, which works for the user interface.
2. start neuron-wallet, works for the wallet functionality.

They are also able to start independently:

# start neuron-ui at `http://localhost:3000`
$ cd packages/neuron-ui && yarn start

# start neuron-wallet
$ cd packages/neuron-wallet && yarn start:dev

Test

# launch the test runner in the watch mode.
$ yarn test