https://github.com/celo-org/faucet
Celo Testnets Faucet
https://github.com/celo-org/faucet
alfajores celo fake faucet test testnet-blockchain testnet-faucet tokens
Last synced: 2 months ago
JSON representation
Celo Testnets Faucet
- Host: GitHub
- URL: https://github.com/celo-org/faucet
- Owner: celo-org
- License: apache-2.0
- Created: 2022-04-26T21:16:59.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-08-07T02:05:16.000Z (2 months ago)
- Last Synced: 2025-08-07T04:06:20.173Z (2 months ago)
- Topics: alfajores, celo, fake, faucet, test, testnet-blockchain, testnet-faucet, tokens
- Language: TypeScript
- Homepage: https://faucet.celo.org
- Size: 96.8 MB
- Stars: 20
- Watchers: 8
- Forks: 22
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Welcome to Alfajores Faucet app
This Repo contains the code for the alfajores faucet. This is contained in 2 apps.
- The firebase app contains functions which do the actual fauceting.
- The web app contains a UI for making requests.
The web app deploys automatically to vercel.
## Setup
### Wep app
To set up the web app to run locally:
1. navigate to the `apps/web` folder
```sh
$ cd apps/web
```
1. link your local repository to the `faucet` project on Vercel
```sh
$ yarn dlx vercel@latest link
```
You'll be asked to authenticate with your Vercel account. Once you've done that, you'll be
guided through a series of prompts to link your local project to the `faucet` Vercel project.
```
? Set up “~/Documents/celo-org/faucet/apps/web”? [Y/n] y
? Which scope should contain your project? Celo Ecosystem Project Hosting
? Link to existing project? [y/N] y
? What’s the name of your existing project? faucet
✅ Linked to c-labs/faucet (created .vercel)
```
1. fetch environment variables from Vercel
```sh
$ yarn dlx vercel@latest env pull
```
If you get an error like `Error! No project found`, you may need to run `vercel link` again.
If everything worked, you should see a message like this:
```sh
> Downloading `development` Environment Variables for Project faucet
✅ Created .env.local file [249ms]
```
1. run the app locally
```sh
$ yarn dev
```
You should see a message like this:
```sh
ready - started server on 0.0.0.0:3000, url: http://localhost:3000
info - Loaded env from /Users/arthur/Documents/celo-org/faucet/apps/web/.env.local
```
You can now view the app in your browser at http://localhost:3000.
## Firebase app
To set up the firebase app to run locally:
1. navigate to the `apps/firebase` folder
```sh
$ cd apps/firebase
```
1. login to firebase
```sh
$ yarn dlx firebase-tools@latest login
```
You'll be asked to authenticate with your Firebase account.
1. build the firebase app
```sh
$ yarn run preserve
```
1. ensure that you are on required node version specified in `engines.node` in
`firebase/package.json`. Currently this is Node 20 at the time of writing.
```sh
$ nvm use
```
1. run the firebase app locally
```sh
$ yarn run serve
```
## Adding chains
### Web
- Add the chain config and token info to `config/chains.ts`.
- Add chain name to the networks array, and `ChainId` and `FaucetAddress` to enums in `types/index.ts`.
### Firebase
Dispatch the deploy-chains workflow. ensure chain name is kebab case and matches a network in `config/chains.ts`.