Skip to content

Latest commit

 

History

History
108 lines (71 loc) · 2.51 KB

developmentEnvironment.md

File metadata and controls

108 lines (71 loc) · 2.51 KB

Augmint RatesFeeder - development environment

Install

Instructions about the dev environment setup for Ratesfeeder development.

For contracs development see augmint-contracts repo

For UI development see augmint-web repo

OSX / Linux

  1. Git

  2. nodejs
    NB: check supported node version in package.json

    Installing nodejs with n node version manager:

    npm install -g n
    n <node version, eg: 10.15.3>
    
  3. Yarn: npm install -g yarn@<yarn version, e.g. 1.15.2>
    NB: check required yarn version in package.json

  4. Docker cli

  5. git clone https://github.com/Augmint/augmint-ratesfeeder.git
    cd augmint-ratesfeeder
    yarn install
    

Windows

Note: windows install was not tested since a while, update on it is welcome

  1. Git Bash

  2. Git (if you haven't installed it as part of Git Bash in previous step)

  3. nodejs
    NB: check supported node version in package.json

    Installing nodejs with Node Version Manager(NVM):

    nvm install <node version number, eg: 10.15.3>
    nvm use 10.15.3
    
  4. Yarn: npm install -g yarn@<yarn version, e.g. 1.15.2>
    NB: check required yarn version in package.json

  5. Docker cli

  6. in Git bash:

    git clone https://github.com/Augmint/augmint-ratesfeeder.git
    cd augmint-ratesfeeder
    yarn install
    

    If python already installed but npm does not find it: npm --add-python-to-path='true' --debug install --global windows-build-tools (as administrator)

Launch

Update to latest augmint-ratesfeeder

git pull
yarn install # if there were any node package changes in packages.json

Tests

  1. Start ganache-cli (formerly testrpc)

    yarn ganache:start
    
  2. Run tests

    yarn test
    

Feeding

Local

yarn ganache:start
yarn start

Production (rinkeby or mainnet)

See .env.production and set your keys in .env.production.local

yarn start:production