create-yespunks-app
v0.1.1
Published
Scaffold a YesPunks builder project
Downloads
198
Readme
YesPunks
Same data. New light.
YesPunks is a transformation layer built on top of the original CryptoPunks dataset.
It exposes punk data through a programmable API and rendering pipeline so builders can create tools, art, and interfaces around the Punks universe.
The artwork is not only the image —
it is the logic that makes the image possible.
Builder Starter
This repository provides a minimal starter for building with the YesPunks API.
Included:
- YesPunks UI theme
- shared header
- API integration
- random YesPunk loader
- SVG rendering pipeline
- builder-friendly project structure
This starter is designed as the entry point for builders exploring the YesPunks ecosystem.
Install
Clone the starter:
git clone https://github.com/yespunks/yespunks-starter
cd yespunks-starter
npm install
npm run devOr generate a project with the CLI:
npx create-yespunks-app my-projectYesPunks API
Base URL:
https://api.yespunks.xyzPublic endpoints:
/api/health
/api/collection
/api/yespunks/:id
/api/yespunks/:id/pixels
/api/yespunks/:id/svg
/api/punks/:id/attributes
/api/punks/:id/pixelsExample Request
GET /api/yespunks/3083/pixelsExample response:
{
"w": 24,
"h": 24,
"palette": ["#fbfbfb", "#12ab34"],
"idx": [-1, -1, 0, 1]
}Limits
60 requests / 60 seconds / IPFormats Supported
- JSON
- SVG
What You Can Build
Builders are already experimenting with:
- punk explorers
- visualizers
- mint interfaces
- generative art systems
- bots
- games
- research tools
The API exposes two layers:
- Original CryptoPunks dataset
- YesPunks transformation layer
Example Usage
Fetch a YesPunk:
fetch("https://api.yespunks.xyz/api/yespunks/3083")Load pixel data:
fetch("https://api.yespunks.xyz/api/yespunks/3083/pixels")You can then render the SVG locally or generate custom outputs.
Builder Rewards
YesPunks actively supports builders.
Selected projects receive YesPunks allocations from the game reserve.
Projects are evaluated based on:
- originality
- usefulness
- technical execution
- contribution to the ecosystem
Strong projects may also be featured across the YesPunks ecosystem.
Links
Website
https://yespunks.xyz
API
https://api.yespunks.xyz
GitHub
https://github.com/yespunks
