162 lines
3.3 KiB
Markdown
162 lines
3.3 KiB
Markdown
# Setting up Development Environment
|
|
|
|
## Install Node.js
|
|
|
|
Install Node.js by your favorite method, or use Node Version Manager by following directions at https://github.com/creationix/nvm
|
|
|
|
```bash
|
|
nvm install v4
|
|
```
|
|
|
|
## Fork and Download Repositories
|
|
|
|
To develop flocore-node:
|
|
|
|
```bash
|
|
cd ~
|
|
git clone git@github.com:<yourusername>/flocore-node.git
|
|
git clone git@github.com:<yourusername>/flocore-lib.git
|
|
```
|
|
|
|
To develop florincoin or to compile from source:
|
|
|
|
```bash
|
|
git clone git@github.com:<yourusername>/florincoin.git
|
|
git fetch origin <branchname>:<branchname>
|
|
git checkout <branchname>
|
|
```
|
|
**Note**: See florincoin documentation for building florincoin on your platform.
|
|
|
|
|
|
## Install Development Dependencies
|
|
|
|
For Ubuntu:
|
|
```bash
|
|
sudo apt-get install libzmq3-dev
|
|
sudo apt-get install build-essential
|
|
```
|
|
**Note**: Make sure that libzmq-dev is not installed, it should be removed when installing libzmq3-dev.
|
|
|
|
|
|
For Mac OS X:
|
|
```bash
|
|
brew install zeromq
|
|
```
|
|
|
|
## Install and Symlink
|
|
|
|
```bash
|
|
cd flocore-lib
|
|
npm install
|
|
cd ../flocore-node
|
|
npm install
|
|
```
|
|
**Note**: If you get a message about not being able to download florincoin distribution, you'll need to compile florincoind from source, and setup your configuration to use that version.
|
|
|
|
|
|
We now will setup symlinks in `flocore-node` *(repeat this for any other modules you're planning on developing)*:
|
|
```bash
|
|
cd node_modules
|
|
rm -rf flocore-lib
|
|
ln -s ~/flocore-lib
|
|
rm -rf florincoind-rpc
|
|
ln -s ~/florincoind-rpc
|
|
```
|
|
|
|
And if you're compiling or developing florincoin:
|
|
```bash
|
|
cd ../bin
|
|
ln -sf ~/florincoin/src/florincoind
|
|
```
|
|
|
|
## Run Tests
|
|
|
|
If you do not already have mocha installed:
|
|
```bash
|
|
npm install mocha -g
|
|
```
|
|
|
|
To run all test suites:
|
|
```bash
|
|
cd flocore-node
|
|
npm run regtest
|
|
npm run test
|
|
```
|
|
|
|
To run a specific unit test in watch mode:
|
|
```bash
|
|
mocha -w -R spec test/services/florincoind.unit.js
|
|
```
|
|
|
|
To run a specific regtest:
|
|
```bash
|
|
mocha -R spec regtest/florincoind.js
|
|
```
|
|
|
|
## Running a Development Node
|
|
|
|
To test running the node, you can setup a configuration that will specify development versions of all of the services:
|
|
|
|
```bash
|
|
cd ~
|
|
mkdir devnode
|
|
cd devnode
|
|
mkdir node_modules
|
|
touch flocore-node.json
|
|
touch package.json
|
|
```
|
|
|
|
Edit `flocore-node.json` with something similar to:
|
|
```json
|
|
{
|
|
"network": "livenet",
|
|
"port": 3001,
|
|
"services": [
|
|
"florincoind",
|
|
"web",
|
|
"insight-api",
|
|
"insight-ui",
|
|
"<additional_service>"
|
|
],
|
|
"servicesConfig": {
|
|
"florincoind": {
|
|
"spawn": {
|
|
"datadir": "/home/<youruser>/.florincoin",
|
|
"exec": "/home/<youruser>/florincoin/src/florincoind"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
**Note**: To install services [insight-api](https://github.com/bitpay/insight-api) and [insight-ui](https://github.com/bitpay/insight-ui) you'll need to clone the repositories locally.
|
|
|
|
Setup symlinks for all of the services and dependencies:
|
|
|
|
```bash
|
|
cd node_modules
|
|
ln -s ~/flocore-lib
|
|
ln -s ~/flocore-node
|
|
ln -s ~/insight-api
|
|
ln -s ~/insight-ui
|
|
```
|
|
|
|
Make sure that the `<datadir>/florincoin.conf` has the necessary settings, for example:
|
|
```
|
|
server=1
|
|
whitelist=127.0.0.1
|
|
txindex=1
|
|
addressindex=1
|
|
timestampindex=1
|
|
spentindex=1
|
|
zmqpubrawtx=tcp://127.0.0.1:28332
|
|
zmqpubhashblock=tcp://127.0.0.1:28332
|
|
rpcallowip=127.0.0.1
|
|
rpcuser=florincoin
|
|
rpcpassword=local321
|
|
```
|
|
|
|
From within the `devnode` directory with the configuration file, start the node:
|
|
```bash
|
|
../flocore-node/bin/flocore-node start
|
|
``` |