PinMe: Zero-Config Frontend Deployment

Deploy Your Frontend in a Single Command. Claude Code Skills supported.

PinMe is a zero-config frontend deployment tool. No servers. No accounts. No setup. Upload your static site to IPFS with one command.

---

Quick Start

# 1. Install globally
npm install -g pinme

# 2. Build your project
npm run build

# 3. Deploy!
pinme upload dist

That's it! Your site is now live on IPFS.

---

Features

• One-Command Deploy - Single pinme upload command deploys your entire site
• Auto-Detection - Automatically finds dist/, build/, out/, public/ directories
• IPFS Hosting - Decentralized, permanent, verifiable content storage
• Zero Config - No accounts, no servers, no setup required
• CI/CD Ready - GitHub Actions integration with AppKey authentication
• Claude Code Skill - Use AI to deploy directly from your IDE

---

Supported Frameworks

Framework	Build Directory
Vite/Vue/Angular	dist/
Create React App	build/
Next.js (export)	out/
Static sites	public/

---

Commands

Command	Description
pinme upload <path>	Upload files to IPFS
pinme list	View upload history
pinme rm <hash>	Remove from IPFS
pinme set-appkey	Set up CI/CD authentication

---

Upload Limits (Free Plan)

• Single file: 200MB max
• Directory: 1GB max
• Required: index.html for websites

---

GitHub Actions Integration

name: Deploy to IPFS
on:
  push:
    branches: [main]

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
      - run: npm ci && npm run build
      - run: npm install -g pinme
      - run: pinme set-appkey ${{ secrets.PINME_APPKEY }}
      - run: pinme upload dist

---

What NOT to Upload

• ❌ node_modules
• ❌ .env files
• ❌ .git directory
• ❌ Source code (src/)
• ❌ Config files

Only upload compiled static assets!

---

Requirements

• Node.js 16.13.0+
• npm, yarn, or pnpm

---

Support

• GitHub Issues: https://github.com/glitternetwork/pinme/issues
• Email: pinme@glitterprotocol.io