Skip to content

Latest commit

 

History

History
96 lines (67 loc) · 2.19 KB

README.md

File metadata and controls

96 lines (67 loc) · 2.19 KB
Raw

Axon Faucet

The Faucet is built using React and Next.js.

How to usage

  1. Add and update .env file:
mv .env.example .env

AXON_FAUCET_REQUIRED_CONFIRMATIONS=10
AXON_FAUCET_CLAIM_VALUE=1000000000000000000

AXON_FAUCET_RPC_URL=<your_axon_rpc_url>
AXON_FAUCET_CHAIN_ID=<your_axon_chain_id>

AXON_FAUCET_MONGODB_URL=<mongodb_url_with_password>
AXON_FAUCET_MONGODB_DB=<mongodb_table_name>
AXON_FAUCET_MONGODB_PASSWORD=<mongodb_password>

AXON_FAUCET_MONGODB_TRANSACTIONS_COLLECTION=Transactions
AXON_FAUCET_MONGODB_ADDRESSES_COLLECTION=Addresses
  1. launch via Docker Compose:
docker compose up
  1. Mnemonic initialization
curl http://localhost:8502/api/import-mnemonic?mnemonic=test%20test%20test%20test%20test%20test%20test%20test%20test%20test%20test%20junk

Contributing

To contribute to the Axon Faucet, follow these steps:

  1. Clone the repository:
git clone https://github.com/axonweb3/axon-faucet.git
  1. Install the dependencies:

We use Yarn as our package manager.

npm install yarn -g
yarn install
  1. Add and update .env file:
mv .env.example .env

AXON_FAUCET_REQUIRED_CONFIRMATIONS=10
AXON_FAUCET_CLAIM_VALUE=1000000000000000000

AXON_FAUCET_RPC_URL=<your_axon_rpc_url>
AXON_FAUCET_CHAIN_ID=<your_axon_chain_id>

AXON_FAUCET_MONGODB_URL=<mongodb_url_with_password>
AXON_FAUCET_MONGODB_DB=<mongodb_table_name>
AXON_FAUCET_MONGODB_PASSWORD=<mongodb_password>

AXON_FAUCET_MONGODB_TRANSACTIONS_COLLECTION=Transactions
AXON_FAUCET_MONGODB_ADDRESSES_COLLECTION=Addresses
  1. Start the development server:
yarn dev
  1. Mnemonic initialization
curl http://localhost:3000/api/import-mnemonic?mnemonic=test%20test%20test%20test%20test%20test%20test%20test%20test%20test%20test%20junk
  1. Open your browser and go to http://localhost:3000/ to see the website in action.

Contributing

We welcome contributions from the community.

License

Axon Website is open-source software licensed under the MIT license.