-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/feat-api-routes'
- Loading branch information
Showing
3 changed files
with
17 additions
and
15 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
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 |
---|---|---|
@@ -1,43 +1,45 @@ | ||
# BlazeKit - A Meta-Framework for Blazor .NET | ||
|
||
**⚠️ BlazeKit is work in progress** | ||
**BlazeKit** provides Meta-framework-like features for Blazor which has been inspired by [SvelteKit](https://kit.svelte.dev/){target="_blank"}. BlazeKit currently supports the following set of features: | ||
|
||
BlazeKit aims to provide Meta-framework-like Features for Blazor which has been inspired by [SvelteKit](https://kit.svelte.dev). BlazeKit currently supports the following features:</p> | ||
- ⚡ Reactive primitives inspired by the signals pattern. | ||
- 🪧 File-based Routing | ||
- 🖼️ File-based Layout Inheritance | ||
- 🖼️ File-based Layouts | ||
- 🤝 File-based API Routes | ||
- 🪄 Auto-Generated Route Parameters | ||
- 📝 Build in Markdown Support for Page Routesa | ||
- ⚡ Reactive primitives inspired by the signals pattern. | ||
|
||
Some more infos can be found at [blazekit.dev](https://blazekit.dev) but keep in mind BlazeKit is work in progress. | ||
> 💡 BlazeKit is unopinionated about the Blazor Hosting Model. BlazeKit works with either **Blazor WebApp** or **Blazor WebAssembly**. | ||
# 🚀 Getting Started | ||
## ☝️ Requirements | ||
Before creating your first BlazeKit project, you should ensure that your local machine has: | ||
- .NET 8 - you can find the download [here](https://dotnet.microsoft.com/en-us/download) | ||
- .NET 8 - you can find the download [here](https://dotnet.microsoft.com/en-us/download){target="_blank"} | ||
|
||
That's it 👍 | ||
|
||
## ✨ Create an app using the CLI | ||
After you have installed the required dependencies, the easiest way to get a project up an running is by using the BlazeKit CLI. | ||
```ps | ||
```shell | ||
# Install the BlazeKit CLI | ||
dotnet tool install --global BlazeKit.CLI --version 0.1.0-alpha.2 | ||
dotnet tool install --global BlazeKit.CLI | ||
``` | ||
Now simply create your first BlazeKit project by running the following command | ||
```ps | ||
```shell | ||
bkit new NextUnicorn | ||
``` | ||
You will be prompted to choose one of the Blazor Hosting Models such as **Blazor WebAssembly** or **Blazor Server**. | ||
You will be prompted to choose one of the Blazor Hosting Models such as **Blazor WebAssembly** or **Blazor WebApp**. | ||
Afterwards a BlazeKit app will be created with the choosen hosting model. | ||
Next **_cd_** into your project folder and start .NET's local development server using the **_dotnet watch_** command | ||
```ps | ||
```shell | ||
cd NextUnicorn | ||
dotnet watch | ||
``` | ||
And here it is, your first BalzeKit project 🎉 | ||
|
||
## 🔄️ Updating the BlazeKit CLI | ||
The easiest way to update the BlazeKit CLI is to simply uninstall and reinstall it. | ||
```ps | ||
```shell | ||
dotnet tool uninstall -g BlazeKit.CLI | ||
dotnet tool install -g BlazeKit.CLI --version 0.1.0-alpha.2 | ||
dotnet tool install -g BlazeKit.CLI | ||
``` |
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