Skip to content
Get packs

Guide · Open source

How to use Blitz: install, create an app and run it

Updated · written with AI from the project's own documentation and checked against our catalogue data

Blitz is an open-source toolkit built on Next.js, the React framework, that aims to cover the parts of building a full web app that Next.js leaves out. This guide shows how to install it, create a new app and start the development server. It is written for developers who already know React and Next.js.

Blitz.jsblitz-js/blitz · ★ 14.1k · MIT

Quick start

  1. 1Install Node.js. Make sure Node.js is installed. The README does not state a required version.
  2. 2Install Blitz globally. Run npm install -g blitz, or yarn global add blitz if you use yarn.
  3. 3Create an app. Run blitz new myAppName to create a new project.
  4. 4Enter the project folder. Run cd myAppName to move into the new app.
  5. 5Start the dev server. Run blitz dev, then open http://localhost:3000 in your browser.

What Blitz is and who it is for

Blitz describes itself as 'The Missing Fullstack Toolkit for Next.js'. It is meant for developers who want to build a complete app, with a database and backend, inside one project.

Its topics list Prisma, which suggests it is commonly paired with that database tool. The README itself gives little guidance for learning JavaScript or React, so it fits people who already have those basics.

  • Good fit: developers comfortable with React and Next.js who want more full-stack structure
  • Good fit: teams building a full web app with a database in a single project
  • Poor fit: complete beginners, or projects that only need a static site or a frontend with no backend

Install Blitz with npm or yarn

You need Node.js, which the README does not give a specific version for, plus npm or yarn. Install Blitz globally with one of the commands below.

You can alternatively use npx, as mentioned in the README.

npm install -g blitz yarn global add blitz

Create a new app

Run blitz new with the name of your project. The README then shows changing into the new folder before starting the dev server.

  • Run blitz new myAppName
  • Run cd myAppName
blitz new myAppName cd myAppName

Start the dev server and open your app

Run blitz dev from inside your project folder. According to the README, you can then view your new app at http://localhost:3000.

blitz dev

Where to get help

For live help, the README points to the Blitz Discord community, where members help each other build Blitz apps. For longer questions, it links to the GitHub discussions forum. Documentation is hosted at blitzjs.com, and the README links a Contributing Guide for people who want to help build Blitz.

What people use it for

  • Building a full web app with a database in a single project
  • Starting a new Next.js-based project that needs backend structure
  • Developing an app that uses Prisma alongside Next.js

Frequently asked questions

Is Blitz free to use?

Blitz is released under the MIT licence, according to the README's licence and the project metadata. The MIT licence generally permits use, modification and distribution, but check the LICENSE file in the repository for the exact terms.

What do I need to install Blitz?

The README lists Node.js and npm or yarn as prerequisites. It does not state which Node.js version is required, so check the official docs at blitzjs.com before you start.

How do I install Blitz?

Run npm install -g blitz, or yarn global add blitz. You can also use npx as an alternative, as the README mentions.

How do I create a new Blitz app?

Run blitz new myAppName, then cd into the folder and run blitz dev. The README says the app is then viewable at http://localhost:3000.

Is Blitz good for beginners?

Not really. The README gives little guidance for learning JavaScript or React, so it is better suited to developers already comfortable with React and Next.js.

How does Blitz compare to Next.js, RedwoodJS or T3 Stack?

Blitz is built on Next.js and adds full-stack structure on top of it. The comparable projects listed are Next.js, RedwoodJS and T3 Stack. The README does not include a detailed comparison, so test each against your needs.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Blitz suits developers who already know React and Next.js and want a single project setup for a full web app, especially with Prisma. If you are learning JavaScript, or you only need a static site or a simple frontend, pick plain Next.js or another tool instead. The README does not describe a release policy, so teams that need long-term version stability should check that before committing.

Install options & downloads