README.md

⚡️ Lightspeed API builder ⚡️

Caution

Do not use in production, this is an alpha version.

🔗 Links

📚 Documentation

🎲 Live Demo

What is Blitz ?

Blitz is a tool that builds restfull APIs on the fly based on a simple and easy to maintain configuration file.

Here is an example of how simple a Blitz file is:

  config:
    name: Hello world
    description: Here is a simple blitz configuration file.
    version: 0.1.0
  resources:
    TodoList:
      name: str
      description: str
    Todo:
      name: str
      due_date: str
      todo_list_id: TodoList.id
      todo_list: TodoList

Note

Also available in Json format.

Installation

Using pipx (recommanded)

pipx install git+https://github.com/Paperz-org/[email protected]

Quickstart

Create a demo blitz app

blitz create --demo

Start the demo

blitz start

Enjoy the demo

The blitz demo already includes resources to explore all the functionalities of Blitz. You can see the Dashboard of the demo blitz app in our Live Demo.

Create a blitz app

blitz create

And yeah, that's it.

Just add some resources in the blitz file, and you now have a fully functional API and the corresponding database schema, along with all the modern features you can expect from a modern app like:

• Automatic Swagger UI for the API
• Admin Interface
• Dashboard: including GPT builder, Blitz file editor, logs ...
• Data Validation and Error Messages (thanks to Fastapi and SQLModel)
• Automatic Database Migration
• Generated ERD Diagram
• and more...

Made with ❤️ and ☕ by mde-pach and pbrochar