🚰 Private Faucet

Meet the Private Faucet, a feather-light faucet tailored for EVM-based private networks. Boasting an incredibly streamlined design, it stands as an ideal choice for individuals seeking an efficient, less demanding resource solution. Provided users are equipped with access to the RPC APIs and a private key linked to a funded account, the faucet can be utilized with utmost ease. At the heart of this creation lies the ambition to offer a straightforward tool that can effortlessly fund addresses interacting with the private network, enhancing user experience and simplicity.

🎯 Purpose

The faucet has been meticulously crafted with an emphasis on speed and simplicity. It stands as a straightforward utility aimed at efficiently funding accounts that engage with the private network. By prioritizing user ease and minimizing complexities, our design ensures that users can swiftly navigate and fund their accounts, thereby promoting seamless interactions within the private network environment.

🛠 Build using

📢 Prerequisites

• NodeJS 16.x

⚙️ Run Locally

Clone the Project and change into the directory

git clone https://github.com/ananthanir/private-faucet
cd private-faucet

Install dependencies

npm install

To connect to any EVM-compatible blockchain network, update the REACT_APP_NODE_RPC_URL value in the .env file.

private-faucet/.env

Line 1 in 55c1373

REACT_APP_NODE_RPC_URL=[rpc_url]

Next the private key to the funding address, update the REACT_APP_FAUCET_ADDRESS_PRIVATE_KEY value in the .env file.

private-faucet/.env

Line 2 in 55c1373

REACT_APP_FAUCET_ADDRESS_PRIVATE_KEY=[funding_address_private_key]

As for the per request ether value, update the REACT_APP_PER_REQUEST_ETHER value in the .env file.

private-faucet/.env

Line 3 in 55c1373

REACT_APP_PER_REQUEST_ETHER="1"

Run the application

npm start

🐳 Docker

Now to run using docker execute the following command

docker compose up -d

🎗️ Contributing

The open source community thrives on the contributions of its members, making it a remarkable space for learning, inspiration, and innovation. Every contribution you offer is deeply valued.

Should you have ideas to enhance this, kindly fork the repository and initiate a pull request. Alternatively, you can open an issue and tag it with enhancement. Remember to star the project! Many thanks!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/<feature_name>)
3. Commit your Changes (git commit -m '<feature_name>_added')
4. Push to the Branch (git push origin feature/<feature_name>)
5. Open a Pull Request

📜 License

This project is licensed under the MIT license - see the LICENSE.md file for details.