blitz README

The project's README from github.com/blitz-js/blitz. As one markdown file: README.md.

Blitz.js


The Missing Fullstack Toolkit for Next.js


Quick Start

Install Blitz

Run npm install -g blitz or yarn global add blitz

You can alternatively use npx

Create a New App

  1. blitz new myAppName
  2. cd myAppName
  3. blitz dev
  4. View your brand new app at http://localhost:3000



Welcome to the Blitz Community 👋

The Blitz community is warm, safe, diverse, inclusive, and fun! LGBTQ+, women, and minorities are especially welcome. Please read our Code of Conduct.

Join our Discord Community where we help each other build Blitz apps. It's also where we collaborate on building Blitz itself.

For questions and longer form discussions, post in our forum.

There's still a lot of work to do, so you are especially invited to join us in building Blitz! A good place to start is The Contributing Guide.


Financial Contributors

Your financial contributions help ensure Blitz continues to be developed and maintained! We have monthly sponsorship options starting at $5/month.

👉 View options and contribute at GitHub Sponsors, PayPal, or Open Collective

🌱 Seedling Sponsors

🥉 Bronze Sponsors

🥈 Silver Sponsors

🏆 Gold Sponsors

💎 Diamond Sponsors


Core Team ✨


Brandon Bayer

Creator

Dillon Raphael

Siddharth Suresh avatar
Siddharth Suresh

Maintainers (Level 2) ✨

Code ownership, pull request approvals and merging, etc (see Maintainers L2)


Simon Knott

SuperJSON

JH.Lee

SuperJSON

Maintainers (Level 1) ✨

Issue triage, pull request triage, community encouragement and moderation, etc (see Maintainers L1)


Jeremy Liberman

Contributors ✨

Thanks to these wonderful people (emoji key):


Brandon Bayer

💻 🖋 🤔 👀 ⚠️ 📖

Rudi Yardley

💻 🤔 👀 ⚠️

Dylan Brookes

💻 🤔 👀 ⚠️ 📖

Adam Markon

💻 🤔 👀 ⚠️ 🚧

Corey Brown

💻 👀 🚧

Lori Karikari

💻 👀 🚧 📖

Elias Johansson

💻 👀 🚧

Michael Edelman

🚇 💻

Todd Geist

💵 💻

Robert Rosenberg

💻 🚧 📖

Beata Obrok

💻

Tahir Awan

💻

Camilo Gonzalez

💻

Daniel Kempner

💻

Giel

💻

Jeremy Liberman

💻 🚧 ⚠️ 📖

Jim Cummins

💻

Kristina Matuška

🎨

Jason Blalock

💻

aej11a

💻

marcoseoane

🤔

Rishabh Poddar

🤔

Lorenzo Rapetti

💻

Justin Hall

💻 📖

Sajjad Hashemian

💻

Eduardo Lopes

💻

Matthew Leffler

📖

blitz (blitz-js/blitz)

Searching Database…

14.1K ·GitHub
What is this?Blitz is a fullstack toolkit built on top of Next.js, adding the missing pieces like a CLI, database ORM integration, and conventions so you can build a complete app without wiring everything yourself.
Is it a framework or just a set of libraries?It is a framework/toolkit layered on Next.js, with its own CLI and generated project structure rather than a single library you import.
How do I create and run a new Blitz app?Install the CLI globally with npm install -g blitz (or yarn global add blitz, or npx), then run blitz new myAppName, cd into it, and run blitz dev.
What stack does a Blitz app rely on under the hood?Blitz apps are built on Next.js and React, use Prisma as the database ORM, and the project itself is written in TypeScript.
Why use Blitz instead of plain Next.js?Blitz adds fullstack conventions on top of Next.js (like direct database access from React components via its data layer) so you skip building your own API boilerplate.
Is Blitz a solo project or community-driven?It has a Core Team, multiple maintainer levels, and an active Discord/forum community, plus financial sponsors via GitHub Sponsors, PayPal, and Open Collective.
Can I try Blitz without installing it globally?Yes, the README notes you can alternatively use npx instead of a global install.
What package manager does the Blitz monorepo itself use?The repo enforces pnpm via a preinstall script (npx only-allow pnpm) and uses Turbo for running build/lint/test tasks.
Creator
blitz-js
Size
121.2 MB
Stars
14.1K
Age
6y
Commits · 90 Days