Skip to content

setup.md

Latest commit

 

History

History
76 lines (53 loc) · 1.49 KB

setup.md

File metadata and controls

76 lines (53 loc) · 1.49 KB

Setup Instructions

Quick Setup

Run this command to install all dependencies:

pnpm install

What Gets Installed

The following dependencies will be installed:

Development Dependencies

  • @types/react - React type definitions
  • @types/react-dom - React DOM type definitions
  • typescript - TypeScript compiler
  • vite - Build tool
  • vite-plugin-dts - TypeScript declaration file generator
  • react - React library (for development)
  • react-dom - React DOM library (for development)

Peer Dependencies (Required by consumers)

  • react ^17.0.0 || ^18.0.0
  • react-dom ^17.0.0 || ^18.0.0

Optional Dependencies (For Web3 features)

  • ethers ^5.0.0 || ^6.0.0
  • wagmi ^1.0.0 || ^2.0.0

Build Commands

After installation, you can:

# Build the package
pnpm run build

# Watch mode for development
pnpm run dev

# Type check without building
pnpm run type-check

Troubleshooting

If you see "Could not find a declaration file for module 'react'"

This means dependencies haven't been installed yet. Run:

pnpm install

If build fails

  1. Delete node_modules and pnpm-lock.yaml
  2. Run pnpm install again
  3. Run pnpm run build

If TypeScript errors persist

Make sure you have TypeScript installed globally or in the project:

pnpm add -D typescript

Next Steps

Once setup is complete:

  1. ✅ Dependencies installed
  2. ✅ Build successful
  3. 📦 Ready to publish or use locally

See README.md for usage examples.