This guide is for contributors who want to run Keep locally for development. If you just want to use Keep, check out the Quickstart guide.
Prerequisites
Before you begin, ensure you have the following installed:- Rust & Cargo
- Solana CLI (use Anza installer)
- Anchor Framework
- Node.js >= 20
- pnpm
Clone Repository
Start Local Validator
Deploy Solana Program
In a new terminal:Configure Server
.env and fill in:
- Resend API key (get one here)
- Database credentials
- Storacha keys
- Admin keypair from script output
Start Development Servers
Get Test SOL
If the airdrop fails due to rate limits, wait a few seconds and retry.
Verify Installation
- Open http://localhost:3000
- Connect your wallet (make sure it’s on testnet)
- Try uploading a test file
If you can successfully upload a file, your local setup is complete!
Troubleshooting
Solana test validator fails to start
Solana test validator fails to start
- Ensure you used the Anza installer
- Remove old ledgers:
rm -rf test-ledger - Set
COPYFILE_DISABLE=trueon macOS
Cannot connect wallet
Cannot connect wallet
- Make sure your wallet is set to testnet/devnet
- Check that the test validator is running
- Verify you have SOL in your wallet
Transaction fails
Transaction fails
- Ensure you have enough SOL for the transaction
- Check that the Solana program is deployed
- Verify the server is running