Faucet Node

A Faucet Node for ZeroLedger protocol

Technologies

• Nestjs with Typescript and SWC
• Jest for unit and e2e testing
• Docker & Docker-compose for dev & prod.
• linters, code formatter, pre-commit and pre-push hooks
• Custom github action and quality gate workflow for fast CI strategy implementation
• Flexible env configuration with encryption, thanks to dotenvx

Requirements

• Git
  • You'll know you've done it right if you can run git --version
• Node.js v20+
• Docker

Installation

npm i

Configuration

Unsecure code

This is PoC code. Please use it carefully

Environment

To properly run node you'll need to configure env files in conf/ directory. All environment variabless are commented for context and assigned to mock values at *.example files.

Local development

1. Create and modify .env file in conf folder:

   cp conf/.example.env conf/.env \

Production

1. Create and modify env files:

   cp conf/.example.env conf/.prod.env

2. Encrypt secrets:

   npm run encrypt

   note: generated .prod.secrets.env can be publicly shared with anyone after encryption

3. Keep generated .env.keys safe and do not commit it into repo

Running

Locally

# Prod mode
npm run build; npm run dev

Testing

# unit tests
npm run test

Contributing

Contributions are always welcome! Open a PR or an issue!

Notes

And you probably already have make installed... but if not try looking here.