Get Started

Quick start

Downloading the repository


git clone git@github.com:allocapital/allo-kit-simple-grants.git

This command clones the AlloKit SimpleGrants code base.

/packages/allo-app
The main Allo App Next.js front-end.
/packages/hardhat
Contains the core Starter Contract at contracts/YourStrategy.sol.
/packages/allo-indexer
Ponder Indexer to store events emitted from the contracts.
/packages/nextjs
Scaffold ETH2’s contract debugger.

Update .env variables

Create .env.local files for both the allo app and the indexer.


cp packages/allo-app/.env.sample packages/allo-app/.env.local
cp packages/allo-indexer/.env.sample packages/allo-indexer/.env.local

Allo App `.env.local`

Update the Pinata variables. This is needed for the creation and indexing of metadata to work properly.

The Alchemy key is needed for RPCs and to fetch the token price in USD from the Indexer.

packages/allo-app/.env.local


ALCHEMY_API_KEY=
 
PINATA_GATEWAY_KEY=
PINATA_JWT=
PINATA_GATEWAY_URL=
 
# Update the WalletConnect Project ID to your own
 
NEXT_PUBLIC_WALLETCONNECT_PROJECT_ID=

Allo Indexer `.env.local`

packages/allo-indexer/.env.local


# Sepolia RPC URL used for fetching blockchain data. Alchemy is recommended.
PONDER_RPC_URL_84532=https://base-sepolia.g.alchemy.com/v2/<alchemy-api-key>
PONDER_RPC_URL_31337="http://localhost:8545" # Hardhat node
 
# Same as above
ALCHEMY_API_KEY=
 
PINATA_JWT=
PINATA_GATEWAY_KEY=
PINATA_GATEWAY_URL=

Development


yarn install
 
yarn run chain          # Run local Ethereum node
yarn run deploy         # Deploy contracts locally
yarn run allo:dev       # Run Allo App
yarn run allo:indexer   # Start the Allo Indexer
 
open localhost:3000     # Open Allo App
open localhost:42069    # Open Ponder Indexer Playground