Merit Development Bootstrap

Getting started

The lightwallet development environment consists of:

Merit Wallet Service
Merit-Node
Insight-api
(Optionally) Insight-ui
Lightwallet for mobile, desktop and web

Prerequisites

Make sure the following conditions are met

GNU/Linux x8632/x86_64, or OSX 64bit (for meritd distributed binaries)_
ZeroMQ (libzmq3-dev for Ubuntu/Debian or zeromq on OSX)
GNU Make version 4.2.1
The lightwallet-stack stably tested on Node.js >= v4.8.4

MacOS Users

MacOS USERS WILL NEED INSTALL THE LATEST XCODE AND ALL UPDATES

Read https://github.com/meritlabs/merit/blob/master/doc/build-osx.md

Install gmake http://braumeister.org/repos/Homebrew/homebrew-core/formula/make

brew install make

Alias your system make to use gmake or add gmake to your path.

# ~/.bash_profile

alias make='/usr/local/Cellar/make/4.2.1_1/bin/gmake'

Deploying

When deploying to staging, add a LW_STAGING=true environment variable before running deploy

To deploy either lightwallet (web), run ./deploy.sh

It will prompt you for if you want to deploy mobile or desktop lightwallet.
It will also ask if you want to deploy to production.

To deploy in unattended mode, run ./deploy.sh -e <environment> -t <target>

Environment can be either staging or production
Target can either be mobile or desktop

Ubuntu Users

# install ZeroMQ
sudo apt install -y libzmq3-dev

# install make
sudo apt install -y make

# install g++
sudo apt install -y build-essential g++

Install Lerna

You need Lerna to manage cross dependencies while still allowing us to publish packages.

Ubuntu USERS NEED TO RUN THIS COMMAND AS ROOT

make prepare-prereqs

Install MongoDB

Merit Wallet Service uses MongoDB

$ brew install mongodb
$ sudo mkdir -p /data/db
$ sudo chmod 0755 /data/db && sudo chown $USER /data/db
$ sudo chmod 0755 /data/ && sudo chown $USER /data/

Starting and Stopping MongoDB

cd merit-labs/lightwallet-stack/
make start-mongo
make stop-mongo

Setup LightWallet-Stack

Run these in the order listed.

make prepare-stack
cp packages/lightwallet/mobile/src/environments/environment.example.ts packages/lightwallet/mobile/src/environments/environment.dev.ts
cp packages/lightwallet/mobile/src/environments/environment.example.ts packages/lightwallet/mobile/src/environments/environment.ts
# here you may want to edit your environment.dev.ts file to modify URLs
make start-lightwallet-stack

Run Mobile LightWallet

make prepare-stack
cp packages/lightwallet/mobile/src/environments/environment.example.ts packages/lightwallet/mobile/src/environments/environment.dev.ts
cp packages/lightwallet/mobile/src/environments/environment.example.ts packages/lightwallet/mobile/src/environments/environment.ts
# here you may want to edit your environment.dev.ts file to modify URLs
make start-lightwallet

Run Desktop LightWallet

make prepare-stack
make start-desktop-lightwallet

Start Meritcore Individually

make start-merit-node

Send an RPC call to the Lightwallet merit-node

make start-merit-node should be running
make symlink-merit-node should be symlinked

cd merit-labs/lightwallet-stack/
./merit-node/merit-node/bin/merit-node call {merit-node/lib/services/meritd.js rpc_command_here}

GIT Flow

For beautifying and improving semantic value of the branches, we decided to use the following list of the branch prefixes:

feature/name-of-the-feature
fix/name-of-the-fix
hotfix/name-of-the-hotfix
chore/name-of-the-job

All new prefixes should be discussed with the community before being added to the ecosystem.

Contributing

Please, check out our Contribution guide and Code of Conduct.

License

Code released under the MIT license.

meritlabs / lightwallet-stack

readme