---

THIS IS THE OLD VERSION OF QUICKDAPP AND IS NO LONGER SUPPORTED! PLEASE CHECK OUT THE LATEST VERSION AT https://github.com/QuickDapp/QuickDapp

---

QuickDapp

Live demo: https://demo.quickdapp.xyz

QuickDapp is a highly opinionated framework that helps you quickly build and deploy Web3 dapps, batteries included.

It is designed to save you a massive amount of time and effort, freeing you up to focus on the parts of your dapp that actually matter.

Roughly speaking, it integrates the following:

• Typescript + Next.js + React as the foundation.
• TailwindCSS + PostCSS + shadcn/ui for components and styling.
• Prisma + PostgreSQL for database storage.
• React-query + GraphQL for AJAX calls.
• RainbowKit + Wagmi + Viem for web3 interaction.
• NextAuth + Sign-in-with-Ethereum for wallet authentication.
• Background job scheduling "worker" with support for cron jobs, repeat-on-failure logic, etc.
• Diamond standard-based upgradeable smart contracts, see @QuickDapp/contracts repository.
• Commander + Enquirer for powerful CLI scripts.
• Docker build scripts for deploying as containers.
• Retype for beautiful, locally-runnable docs.
• DigitalOcean for production deployments.
• Sendgrid integration for email sending.
• Ably integration for real-time push notifications to clients.
• Sentry integration for metrics and tracing.

Please visit https://quickdapp.xyz for more information.

Getting started

Pre-requisites:

• Node.js v20+.
• PNPM.
• PostgreSQL 11+ running locally on port 5432, with a default admin user called postgres.

Install the packages:

pnpm i

Run the bootstrap script:

pnpm bootstrap

Please refer to the "Getting Started" tutorial for further instructions. You can display the documentation in the browser by running:

pnpm showdocs

License

MIT - see LICENSE.md