-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
35 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,7 +5,7 @@ | |
| <em>⚡️ Lightspeed API builder ⚡️</em> | ||
| </p> | ||
|
|
||
|  | ||
|  | ||
|  | ||
|
|
||
| > [!CAUTION] | ||
|
|
@@ -18,45 +18,57 @@ Blitz is a tool that builds restfull APIs on the fly based on a simple and easy | |
|
|
||
| Here is an example of how simple a Blitz file is: | ||
| ```yaml | ||
| config: | ||
| name: Hello world | ||
| description: Here is a simple blitz configuration file. | ||
| version: 0.1.0 | ||
| resources: | ||
| - name: TodoList | ||
| fields: | ||
| name: str | ||
| description: str | ||
| - name: Todo | ||
| fields: | ||
| name: str | ||
| due_date: str | ||
| todo_list_id: TodoList.id | ||
| todo_list: TodoList | ||
| 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. | ||
| # Quickstart | ||
| ## Installation | ||
| # Installation | ||
| ### Using [pipx](https://pipx.pypa.io/stable/installation/) (recommanded) | ||
| ```bash | ||
| pipx install git+https://github.com/Paperz-org/[email protected] | ||
| ``` | ||
|
|
||
| ## Create a blitz app | ||
| # Quickstart | ||
|
|
||
| ## Create a demo blitz app | ||
|
|
||
| ```console | ||
| blitz create your-blitz-app | ||
| blitz create --demo | ||
| ``` | ||
|  | ||
|
|
||
| ## Start the demo | ||
|
|
||
| ## Start your blitz app | ||
| ```console | ||
| blitz start | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| ## Enjoy the demo | ||
|
|
||
| The blitz demo already includes resources to explore all the functionalities of Blitz. | ||
|
|
||
| ## Create a blitz app | ||
|
|
||
| ```console | ||
| blitz start your-blitz-app | ||
| blitz create | ||
| ``` | ||
|  | ||
|
|
||
| *And yeah, that's it.* | ||
|
|
||
|
|
||