⚡ TurboETH - Web3 App Starter Kit

Web3 App Template built using Next.js, RainbowKit, Tailwind, Sign-In With Ethereum, and more.

Documentation

• Getting Started
  • Environment Variables
  • JSON-RPC
  • WAGMI CLI
  • UI Components
  • Backend Database
• Core Integrations
  • 🌈 RainbowKit
  • 🔏 Sign-In With Ethereum
• Smart Contract Integrations
  • ERC20
• API Integrations
  • Disco
  • Etherscan

Getting Started

The pnpm CLI is the recommended package manager but npm and yarn should work too.

pnpm install

Development

pnpm dev

Build

pnpm build

Web3 Core

• WAGMI CLI - Automatic React Hook Generation
• RainbowKit - Wallet connection manager
• Sign-In With Ethereum - Account authentication

Web2 Frameworks

• Vercel - App Infrastructure
• Prisma - Database ORM

Developer Experience

• TypeScript – Static type checker for end-to-end typesafety
• Prettier – Opinionated code formatter for consistent code style
• ESLint – Pluggable linter for Next.js and TypeScript

User Interface

• TailwindCSS – Utility-first CSS framework for rapid UI development
• Radix – Primitives like modal, popover, etc. to build a stellar user experience
• Framer Motion – Motion library for React to animate components with ease
• React Icons – Beautifully simple, pixel-perfect icons

The ui.shadcn.com components are included in the /components/shared/ui folder.

💻 Developer Experience

🐕 What is husky

Husky improves your git commits.

You can use it to lint your commit messages, run tests, lint code, etc... when you commit or push. Husky supports all Git hooks.

🪝 Hooks

• pre-commit: lint app codebase
• commit-msg: apply commintlint

📋 What is commitlint

commitlint checks if your commit messages meet the conventional commit format.

In general the pattern mostly looks like this:

type(scope?): subject  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")

Real world examples can look like this:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Common types according to commitlint-config-conventional (based on the Angular convention) can be:

• build
• chore
• ci
• docs
• feat
• fix
• perf
• refactor
• revert
• style
• test

Acknowledgements

Original template was forked from https://github.com/wslyvh/nexth

Thank you @wslyvh 🙏

---

Copyright 2023 Kames Geraghty