No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.idea
api/http
docs
helpers
logic
logs
modules
node_modules
pids
public
schema
sql
tasks
test
Gruntfile.js
Jenkinsfile
LICENSE
README.md
app.js
build
config.json
genesisBlock.json
logger.js
package.json
test.sh

README.md

FRS

Prerequisites - In order

This sections provides details on what you need install on your system in order to run FRS.

System Install

  • Tool chain components -- Used for compiling dependencies

    • Ubuntu/Debian:

      sudo apt-get update
      sudo apt-get install -y python build-essential curl automake autoconf libtool
      
    • MacOS 10.12-10.13 (Sierra/High Sierra):

      Make sure that you have both XCode and Homebrew installed on your machine.

      Update homebrew and install dependencies:

      brew update
      brew doctor
      brew install curl automake autoconf libtool
      
  • Git (https://github.com/git/git) -- Used for cloning and updating FRS

    • Ubuntu/Debian:

      sudo apt-get install -y git
      
    • MacOS 10.12-10.13 (Sierra/High Sierra):

      brew install git
      

Node.js (https://nodejs.org/)

  • Node.js serves as the underlying engine for code execution.

    Install System wide via package manager:

    • Ubuntu/Debian:

      curl -sL https://deb.nodesource.com/setup_6.x | sudo -E bash -
      sudo apt-get install -y nodejs
      
    • MacOS 10.12-10.13 (Sierra/High Sierra):

      brew install node@6
      
  • (Recommended) Install n -- Used for Node.js version management

    npm install -g n
    n 6.12.1
    
  • (Recommended) PM2 (https://github.com/Unitech/pm2) -- PM2 manages the node process for FRS

    npm install -g pm2
    

Special note about NPM 5

Due to an issue with NPM 5.4.x and higher, node-sodium currently cannot be built. Therefore it is recommended to fixate the local NPM version at 5.3.x if you are running NPM 5.4.x or higher.

All Systems - This may require sudo depending on your environment:

npm install -g npm@5.3.0

PostgreSQL (version 9.6.6):

  • Ubuntu/Debian:

    curl -sL "https://downloads.lisk.io/scripts/setup_postgresql.Linux" | bash -
    sudo -u postgres createuser --createdb $USER
    createdb frs_test
    createdb frs_main
    sudo -u postgres psql -d frs_test -c "alter user "$USER" with password 'password';"
    sudo -u postgres psql -d frs_main -c "alter user "$USER" with password 'password';"
    
  • MacOS 10.12-10.13 (Sierra/High Sierra):

    brew install postgresql@9.6
    initdb /usr/local/var/postgres -E utf8
    brew services start postgresql@9.6
    createdb frs_test
    createdb frs_main
    

Installing Redis

  • Ubuntu/Debian:

    sudo apt-get install redis-server
    

    Start redis:

    service redis start
    

    Stop redis:

    service redis stop
    
  • MacOS 10.12-10.13 (Sierra/High Sierra):

    brew install redis
    

    Start redis:

    brew services start redis
    

    Stop redis:

    brew services stop redis
    

NOTE: FRS does not run on the redis default port of 6379. Instead it is configured to run on port: 6380. Because of this, in order for Lisk to run, you have one of two options:

  1. Change the FRS configuration

Update the redis port configuration in both config.json. Note that this is the easiest option, however, be mindful of reverting the changes should you make a pull request.

  1. Change the Redis launch configuration

Update the launch configuration file on your system. Note that their a number of ways to do this. The following is one way:

  1. Stop redis-server
  2. Edit the file redis.conf and change: port 6379 to port 6380 - Ubuntu/Debian: /etc/redis/redis.conf - MacOS: /usr/local/etc/redis.conf
  3. Start redis-server

Now confirm that redis is running on port 6380:

redis-cli -p 6380
ping

And you should get the result PONG.

Installation Steps

Clone the FRS repository using git and initialize the modules.

git clone https://github.com/FRSnetwork/frs.git
cd frs
git checkout master
npm install

Managing FRS

To test that FRS is built and configured correctly, issue the following command:

node app.js

Once the process is verified as running correctly, CTRL+C and start the process with pm2. This will fork the process into the background and automatically recover the process if it fails.

pm2 start --name frs app.js

After the process is started, its runtime status and log location can be retrieved by issuing the following command:

pm2 show frs

To stop FRS after it has been started with pm2, issue the following command:

pm2 stop frs

NOTE: The port, address and config-path can be overridden by providing the relevant command switch:

pm2 start --name frs app.js -- -p [port] -a [address] -c [config-path]

License

Copyright © 2017-2018 FRS Platform

Copyright © 2016-2017 Lisk Foundation

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.


This program also incorporates work previously released with lisk 0.7.0 (and earlier) versions under the MIT License. To comply with the requirements of that license, the following permission notice, applicable to those parts of the code only, is included below:

Copyright © 2016-2017 Lisk Foundation
Copyright © 2015 Crypti

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.