Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/feat-api-routes'
Browse files Browse the repository at this point in the history
  • Loading branch information
koeeenig committed Dec 13, 2023
2 parents 0d38d40 + 3146a0a commit d346531
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 15 deletions.
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<VersionPrefix>0.1.0</VersionPrefix>
<VersionSuffix>alpha.1</VersionSuffix>
<VersionSuffix></VersionSuffix>
<Author>Andreas König</Author>
<Company>BlazeKit</Company>
<Description>BlazeKit is a Meta-Framework for Blazor</Description>
Expand Down
28 changes: 15 additions & 13 deletions README.md
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
```
2 changes: 1 addition & 1 deletion src/BlazeKit.Site/Routes/Page.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

<blockquote class="callout">
<div>💡</div>
<div>BlazeKit is unopinionated about the Blazor Hosting Model. BlazeKit works with either <strong>Blazor Server</strong>,<strong>Blazor WebAssembly</strong> or the new <strong>Blazor Server-Side Rendering</strong> Model.</div>
<div>BlazeKit is unopinionated about the Blazor Hosting Model. BlazeKit works with either <strong>Blazor WebApp</strong> or <strong>Blazor WebAssembly</strong> Model.</div>
</blockquote>

Want to get started with BlazeKit? Head over to [Getting Started](/create-a-project) to create your first Blazekit app.
Expand Down

0 comments on commit d346531

Please sign in to comment.