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
**/pulumi - pulumi infrastructure logic for deployment

Dependencies

Node.js
- NVM (recommended to install Node.js and npm)
Yarn - package management
OpenJDK 11 - required for openapi-generator-cli to generate api clients from OpenAPI specs

Initial Setup

Any commands should be run from within unchained/node
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 coinstacks/ethereum/sample.env coinstacks/ethereum/.env

Fill out any missing variables
- Create an Etherscan Account for a free API key