README.md

Unchained (Node)

Helpful Docs

• TSOA

Project Structure

• packages - shared internal packages across coinstacks
• coinstacks/common - common coinstack logic to reduce duplication
• coinstacks/{coin} - coin specific logic

Dependencies

• Node.js
  • NVM (recommended to install Node.js and npm)
• Yarn - package management

Initial Setup

• Install Node.js LTS

  • (Optional) use nvm to automatically install the node version specified in .nvmrc

    nvm use

• Install Yarn

  npm install --global yarn

• Install dependencies:

  yarn

• Build project:

  yarn build

  build step must be run locally before attempting to docker-compose up

• Copy sample env file:

  cp node/coinstacks/ethereum/sample.env node/coinstacks/ethereum/.env

• Fill out any missing variables

  • Create an Etherscan Account for a free API key