Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ===============================
# OnchainKit Environment Example
# ===============================

# Coinbase OnchainKit API Key
# Replace with your actual key (if you have one)
# You can leave this empty for open-source / Storybook builds
NEXT_PUBLIC_ONCHAINKIT_API_KEY=

# Wagmi / Ethereum Chain Settings
# Example: base, mainnet, polygon, etc.
NEXT_PUBLIC_DEFAULT_CHAIN=base

# Analytics or telemetry flags (optional)
ENABLE_ANALYTICS=false

# Storybook environment flag
STORYBOOK_ENV=local
25 changes: 25 additions & 0 deletions .github/workflows/storybook-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Storybook Build Check

on:
pull_request:
push:
branches: [main]

jobs:
storybook-build:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'pnpm'

- name: Install dependencies
run: pnpm install

- name: Build Storybook
run: pnpm --filter @coinbase/onchainkit run build-storybook
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,14 @@ Then, you can view the playground at [http://localhost:3000](http://localhost:30
## 🌊 License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

## 🐳 Running with Docker

You can build and run the project locally using Docker without installing Node.js or pnpm manually.

```bash
# Build the image
docker build -f tools/docker/Dockerfile -t onchainkit .

# Run the app
docker run -it --rm -p 3000:3000 onchainkit
9 changes: 9 additions & 0 deletions tools/docker/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
node_modules
dist
build
.cache
.git
.github
.vscode
*.log
*.tsbuildinfo
15 changes: 15 additions & 0 deletions tools/docker/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
FROM node:20-alpine

WORKDIR /app

COPY package.json pnpm-lock.yaml pnpm-workspace.yaml ./

RUN npm install -g pnpm

COPY . .

RUN pnpm install --frozen-lockfile

EXPOSE 3000

CMD ["pnpm", "--filter", "playground", "dev"]