Vertiq.Templates 5.7.1

<img src="img/vertiq.svg" width="100px" />

Vertiq

A highly modular Framework to write Blazor Applications with a hassle free vertical sliced architecture - Easy. Flexible. Focused.

This includes various platforms Blazor can run on such as: Blazor Server Side / Blazor Wasm / Blazor MAUI / Blazor Mobile Bindings without a single change in your code!

Platform support: .net6.0 and upper.

• Quick start
• Documentation
• Nuget
• Online-Demo

Usage & Installation

Start by (re)installing the templates to the latest version

dotnet new install Vertiq.Templates 

Afterwards you will be able to start a simple project by running

REM There is currently a bug in the net7.0 SDK so we use net6.0
dotnet new globaljson --sdk-version 6.0.400 --roll-forward patch --force
REM Install the b-tool
dotnet tool install -g b-tool
REM Create the project
dotnet new vertiq-blazor-server -o AcmeProject
REM change dir
cd AcmeProject
REM create a git repo
git init && git add . && git commit -m "feat: initial commit"
REM build the project
b
REM run the project
b run -s

Contributing

Prerequisites

You need to have node v12, Yarn and dotnet sdk net6.0 or higher installed on your local machine.

Building

You should be able to build the project by using the build scripts:

#Windows
build.bat
#Or for short
b.bat
#Or for powershell
./build.ps1

#Linux & MacOS
. build.sh

However we recommend you use the b-tool to build the project by installing it via

dotnet tool install -g b-tool
REM To build just call b afterwards
b

Afterwards you will be able to build by simply calling b on any platform. You also can specify arguments just by passing them to the tool by a space for example: b test. This even works if you current directory is a subdirectory of the project.

The project uses bullseye to list individual targets use b -l. To run individual targets call b targetname -s

Testing

Some of the integration tests use Docker. On Windows or MacOS please install Docker Desktop. Afterwards the dockerized tests will run automatically.

Releasing

We follow the semver pattern to for versioning our packages. Please use the r-tool to automate the release process. To install it run:

dotnet tool install -g r-tool

And run r and follow the wizard to guide you to the release publishing process.

Writing docs

We use the Feature-Center as a custom tool to write the documentation. To serve up docs simply call dotnet run --project demo\FC\FC\FC.csproj and open https://localhost:7130. All documentation is in the demo/FC/FC.Module directory.

Licensing

Vertiq is available for commercial usage to a thirty-day trial period, after which a license fee must be paid to obtain a license. Please contact us via sales@vertiq.io.