https://github.com/coinbase/onchain-app-template
https://github.com/coinbase/onchain-app-template
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/coinbase/onchain-app-template
- Owner: coinbase
- License: mit
- Created: 2024-08-05T16:50:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T14:44:21.000Z (about 1 year ago)
- Last Synced: 2025-04-10T16:01:18.388Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://onchain-app-template.vercel.app
- Size: 790 KB
- Stars: 129
- Watchers: 7
- Forks: 165
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Onchain App Template
An Onchain App Template built with [OnchainKit](https://onchainkit.xyz), ready for deployment on Vercel.
Demo: https://onchain-app-template.vercel.app
## Quick Start
### Deploy to Vercel
Deploy directly to Vercel with one click:
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fcoinbase%2Fonchain-app-template%23)
**Note:** Configure environment variables in Vercel project settings after deployment.
## Manual Setup
### Environment Variables
Configure a `.env` file with the following variables (reference `.env.local.example`):
```sh
# Obtain from https://portal.cdp.coinbase.com/products/onchainkit
NEXT_PUBLIC_CDP_API_KEY="GET_FROM_COINBASE_DEVELOPER_PLATFORM"
# Obtain from https://cloud.walletconnect.com
NEXT_PUBLIC_WC_PROJECT_ID="GET_FROM_WALLET_CONNECT"
```
You can obtain the API key from the [Coinbase Developer Portal's OnchainKit page](https://portal.cdp.coinbase.com/products/onchainkit). If you don't have an account, you will need to create one.
For the Wallet Connector project ID, visit [Wallet Connect](https://cloud.walletconnect.com) and create/access your project.
### Local Development
```sh
# Install bun
curl -fsSL https://bun.sh/install | bash
# Install dependencies
bun i
# Start development server
bun run dev
```
## Resources
- [OnchainKit Cursor Rules](https://cursor.directory/onchainkit)
- [OnchainKit llms.txt](https://docs.base.org/builderkits/onchainkit/llms.txt)
- [OnchainKit Documentation](https://onchainkit.xyz)
- [OnchainKit Early Adopter Contract](https://github.com/neodaoist/onchainkit-early-adopter) by neodaoist [[X]](https://x.com/neodaoist)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Support
For assistance, please contact us through:
- [Discord](https://discord.gg/8gW3h6w5)
- [GitHub Issues](https://github.com/coinbase/onchainkit/issues)
- X: [@onchainkit](https://x.com/onchainkit), [@zizzamia](https://x.com/zizzamia), [@fkpxls](https://x.com/fkpxls)