Skip to content

Latest commit

 

History

History
88 lines (60 loc) · 2.78 KB

developmentEnvironment.md

File metadata and controls

88 lines (60 loc) · 2.78 KB

Augmint Web Frontend - development environment

Install

These instructions are about the dev environment for frontend development. For contract development see augmint-contracts repo

OSX / Linux

  1. Git

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

    or install nodejs with n node version manager:

    npm install -g n
n <node version, eg: 10.15.3>

  3. Install yarn if you don't have it: npm install -g yarn@<version>
    NB: check required yarn version in package.json

  4. Docker cli - Optional but required for running tests

  5. git clone https://github.com/Augmint/augmint-web.git
cd augmint-web
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

    or install nodejs with Node Version Manager(NVM):

    nvm install <node version number, eg: 10.15.3>
nvm use 10.15.3

  4. Install yarn if you don't have it: npm install -g yarn@<version> NB: check required yarn version in package.json

  5. If you want to run on local test blockchain (eg. for tests) then Install docker cli

  6. in Git bash:

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

Launch

Update to latest augmint-web

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

Start & stop ganache-cli (formerly testrpc) - Optional but required for tests

  • yarn ganache:start
  • yarn ganache:stop

Launch local dev server

yarn start

NB: If you are using Metamask on local chain (e.g. ganache in docker) and you restart the local chain then your consecutive transactions will fail with Invalid nonce error. You will need to reset your account in Metamask.

Tests

Jest only

yarn test

FrontEnd - E2E

  • interactive: yarn cypress:open
  • command line: yarn cypress:run

Non ganache launches/deploys

See augmint-contracts repo