Skip to content
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 15 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,17 @@ It *stores all keys locally* in the browser, *never exposing your keys to anyone

## Getting started

BitShares-UI depends node Node.js, and version 8+ is required.
BitShares-UI depends node (Node.js), we recommend using node version 10.
Comment thread
AmmarYousefM marked this conversation as resolved.
Outdated

On Ubuntu and OSX, the easiest way to install Node is to use the [Node Version Manager](https://github.com/creationix/nvm).

To install NVM for Linux/OSX, simply copy paste the following in a terminal:
To install node for Linux/Ubuntu 20.04.2 (LTS), simply copy paste the following in a terminal:

```
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.30.2/install.sh | bash
nvm install v9
nvm use v9
Comment thread
AmmarYousefM marked this conversation as resolved.
apt install curl -y
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
apt install nodejs -y
```

Once you have Node installed, you can clone the repo:
Once you have node installed, you can clone the repo:

```
git clone https://github.com/bitshares/bitshares-ui.git
Expand All @@ -30,7 +28,8 @@ cd bitshares-ui
Before launching the GUI you will need to install the npm packages:

```
npm install
npm ci
Comment thread
AmmarYousefM marked this conversation as resolved.
Outdated
npm run install-charting-library
```

## Running the dev server
Expand All @@ -45,14 +44,6 @@ npm start

Once the compilation is done the GUI will be available in your browser at: `localhost:8080` or `127.0.0.1:8080`. Hot Reloading is enabled so the browser will live update as you edit the source files.


## Testnet
By default bitshares-ui connects to the live BitShares network, but it's very easy to switch it to the testnet run by Xeroc. To do so, open the UI in a browser, go to Settings, then under Access, select the *Public Testnet Server* in the dropdown menu. You should also change the faucet if you need to create an account, the testnet faucet address is https://testnet.bitshares.eu.

The UI will reload and connect to the testnet, where you can use the faucet to create an account and receive an initial sum of test BTS.

![image](https://cloud.githubusercontent.com/assets/6890015/22055747/f8e15e68-dd5c-11e6-84cd-692749b578d8.png)

## Production
If you'd like to host your own wallet somewhere, you should create a production build and host it using NGINX or Apache. In order to create a prod bundle, simply run the following command:

Expand All @@ -61,6 +52,13 @@ npm run build
```
This will create a bundle in the ./build/dist folder that can be hosted with the web server of your choice.

## Testnet
By default bitshares-ui connects to the live BitShares network, but it's very easy to switch it to the testnet run by Xeroc. To do so, open the UI in a browser, go to Settings, then under Access, select the *Public Testnet Server* in the dropdown menu. You should also change the faucet if you need to create an account, the testnet faucet address is https://testnet.bitshares.eu.

The UI will reload and connect to the testnet, where you can use the faucet to create an account and receive an initial sum of test BTS.

![image](https://cloud.githubusercontent.com/assets/6890015/22055747/f8e15e68-dd5c-11e6-84cd-692749b578d8.png)


### Installable wallets
We use Electron to provide installable wallets, available for Windows, OSX and Linux Debian platforms such as Ubuntu. First, make sure your local python version is 2.7.x, as a dependency requires this.
Expand Down