Skip to content

NewCapital/TWIX-Faucet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TWIX Faucet v1.0.0

License

Claim tokens for development and testing purposes on the TWIX network.


Simply enter the recipient address, the desired amount of the selected token and claim.


Requirements

Node.js is required to run TWIX Faucet as a web application, version 12 LTS is recommended.

Building instructions

  1. Clone the project.
git clone https://github.com/NewCapital/TWIX-Faucet.git
  1. Navigate to the project folder.
cd TWIX-Faucet
  1. Install the dependencies. This may take a while.
npm install 
  1. Build the packages.
npm run build
  1. Start the app.
npm start
  1. Access the Faucet on your web browser. The default may be http://127.0.0.1:4000. If you get a "connection refused" or "init failed" error, check your .env file.

Feature status

Features currently working

  • Real-time display of status notifications ✔️
  • Claiming selected token (from 1 up to maximum amount) to a specified recipient ✔️

Features currently not working

  • Nothing to report so far.

Main changes

  • Altered UI elements (footer, colors, text, images) for a more appealing, consistent and coherent appearance.
  • Changed terminology (Mosaics changed to Tokens).
  • Removed some irrelevant UI elements for less intrusive appearance.

Known issues

  • No major known issues so far.

Customization (.env file example)

# set enviroment variables
# DEFAULT_NODE
# HOST
# PORT= (default: 3000)
# NATIVE_CURRENCY_NAME
# NATIVE_CURRENCY_ID
# NATIVE_CURRENCY_OUT_MAX
# NATIVE_CURRENCY_OUT_MIN
# FAUCET_PRIVATE_KEY
# MAX_FEE
# ENOUGH_BALANCE
# MAX_UNCONFIRMED
# BLACKLIST_MOSAIC_ID
# EXPLORER_URL