Get Started with Blitz

Set Up Your Computer

You need Node.js 12 or newer. You can verify this by running node -v in your terminal. If you don't have Node or need a newer version, we recommend using a node version manager like fnm. That will allow you to easily change node versions and even have different versions for each project.

Install Blitz

Run yarn global add blitz or npm install -g blitz --legacy-peer-deps (legacy-peer-deps is needed because npm totally change behavior of peer deps and some dependencies haven't caught up)

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.

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.

For a full introduction, read How the Community Operates. This details everything, including how to get help, how to report bugs, how to suggest new features, etc.

You are invited to help make Blitz the best it can be! 🤝

We have an awesome community that's working together to make Blitz the best framework the world has ever seen.

How you can help:

1. Report bugs by opening an issue on GitHub
2. Contribute code: Read the contributing guide so see how to get started.
3. Sponsorships & donations, which start at $5/month
4. Any other way you want! We totally appreciate any type of contribution, such as documentation, videos, blog posts, etc. If you have an unusual idea, feel free to run it past us in Discord! :)

Next Steps

Tutorial

The Tutorial is a full walkthrough through all the fundamental parts of Blitz, including adding models to your database and reading and updating data from your frontend.

Learning

And here's major aspects of Blitz that you'll want to become familiar with.

• How to make Pages
• How to use the File-System Routing
• How to set up and use a Database
• How to use Blitz Queries and Mutations for reading and writing data to your database
• How to scaffold all the code for database models with the blitz generate command