Shelby Examples

🌐 Website: shelby.xyz  |  📚 Documentation: docs.shelby.xyz  |  🐙 GitHub: github.com/shelby  |  🐦 Twitter: @shelbyserves

A collection of examples demonstrating various features and capabilities of the Shelby ecosystem. This repository is modeled after Vercel's examples repository and serves as a comprehensive resource for developers building with Shelby.

What's Inside

This Turborepo includes the following example applications:

Applications

Name	Description	Path & Links
@shelby-protocol/ai-image-generation	Shelby AI image generation example	apps/ai-image-generation
@shelby-protocol/cross-chain-accounts	Shelby cross chain accounts example	apps/cross-chain-accounts
@shelby-protocol/download-example	An example app to demonstrate downloading blobs using the Shelby SDK	apps/download-blob
@shelby-protocol/list-example	An example app to demonstrate listing blobs using the Shelby SDK	apps/list-blob
@shelby-protocol/upload-example	An example app to demonstrate uploading blobs using the Shelby SDK	apps/upload-blob

Each application is 100% TypeScript and follows Shelby's development standards.

Development Tools

This repository comes pre-configured with:

• TypeScript for static type checking
• Biome for code formatting and linting
• Turborepo for efficient monorepo management
• pnpm for fast, efficient package management

Getting Started

Prerequisites

• Node.js >= 22.15.0
• pnpm >= 10.10.0

Installation

1. Clone the repository:

git clone https://github.com/shelby/examples.git
cd examples

2. Install dependencies:

pnpm install

Development

To develop all applications:

pnpm dev

To develop a specific application:

# Develop the web application
pnpm dev --filter=@shelby-protocol/web

Building

To build all applications:

pnpm build

To build a specific application:

# Build the web application
pnpm build --filter=@shelby-protocol/web

Code Quality

Format code:

pnpm fmt

Lint code:

pnpm lint

Run tests:

pnpm test:once

Table Maintenance

The applications table above is automatically maintained by the @shelby-protocol/table-generator package:

Update the table:

pnpm update-table

Check if table is up to date:

pnpm check-table

The table generator scans all applications in the apps/ directory and automatically updates the README with current information including names, descriptions, and links. This ensures the documentation stays synchronized with the actual codebase.

Contributing

We welcome contributions to the Shelby examples repository! Please read our contributing guidelines and feel free to submit issues and pull requests.

---

Built with ❤️ by the Shelby team