Powered by

# Introduction

QuickDapp is a highly opinionated modern web application boilerplate with built-in Web3 support. It helps you quickly build and deploy web applications, 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 application that actually matter.

# Core Features

  • Bun + ElysiaJS + React as the foundation. Bun is the only supported package manager.
  • TailwindCSS + Radix UI for components and styling.
  • DrizzleORM + PostgreSQL for database storage.
  • GraphQL Yoga + React Query for AJAX calls.
  • JWT token authentication with multiple providers (email, OAuth, and SIWE).
  • Background job scheduling "worker" system with support for cron jobs, repeat-on-failure logic, etc.
  • Commander for powerful CLI scripts.
  • Binary distribution for self-contained deployments.
  • WebSocket integration for real-time communication.
  • Comprehensive test framework with integration testing.

# Web3 Features (Optional)

  • RainbowKit + Wagmi + Viem for blockchain interaction.
  • Sign-in-with-Ethereum for wallet-based authentication.
  • Sample factory-based smart contracts in sample-contracts/ for local development and testing.

As you can see above, QuickDapp does a lot for you out of the box.

QuickDapp also comes with a built-in worker system that can handle background jobs, cron tasks, and optionally blockchain monitoring. You can deploy the worker processes separately or combine them into a single binary. All using the readily available build scripts.

For Web3 developers, the base QuickDapp distribution includes a sample application that demonstrates deploying and interacting with ERC-20 contracts on Sepolia, so you can see all the elements of a working Web3 application from the get-go.

# Why does this exist?

If you've ever built multiple web applications you'll have found yourself reusing code and integrations from one project to the next to save time. Still, you'll need to spend time adapting the base layer to suit the new application.

Now, imagine the reusable part of a web application was built to be generically usable for any project with some sensible defaults included. And imagine it had ready integrations for production deployment with baked-in support for useful features like background jobs, real-time updates, comprehensive testing, and optional blockchain integration. This would save you a tonne of time.

This is exactly what QuickDapp is.

# What if I don't like something?

QuickDapp has been carefully designed to give you the flexibility to build whatever you want without having to change the core structure. However, you may wish to replace some of the peripheral components (e.g the logging provider or database) with your own choices.

In these cases it's easy to do so since QuickDapp is distributed as source code which you then modify/enhance to build your application. Meaning that any and every aspect of QuickDapp can be modified as you see fit. There are no limits or restrictions.

Note that parts of the documentation will touch on how you can customize and/or replace certain components to your liking whilst still taking advantage of QuickDapp's other useful features.

# Where do I start?

The Getting Started section will get you up and running quickly.

The remainder of this documentation gives you a thorough understanding of all the different parts of QuickDapp and how to get the most out of the framework as a whole.