Create project

Let's make our next cross platform project a success with Bit.Boilerplate.

dotnet new bit-bp --name MyFirstProject

Name

--name MyFirstProject

It is required to specify a name for your project.

.NET

--framework net9.0

Refer to the .NET Support Policy

Server Database

--database Sqlite

The API project requires an Entity Framework Core DbContext for tables such as ASP.NET Core Identity.

Supported options include SqlServer, PostgreSQL, MySQL and Other.

For the default Sqlite option, we'd recommend installing sqlite package for Visual Studio and Visual Studio Code.

File Storage

--filesStorage Local

The API project includes an Attachment Controller responsible for handling user images, including resizing and saving them in the WebP format using FluentStorage

Local option stores files on local hard drive.

API

--api Integrated

Select the API mode that best aligns with your specific requirements.

Easily debug and deploy Server.Web projects that serves restful API services, SSR, Blazor Server, Blazor Auto and pre-rendering.

Pipeline

--pipeline GitHub

Ensure a rapid and reliable deployment by utilizing a pipeline. By selecting GitHub, CI/ CD pipelines will be set up using Github Actions.

Module

--module None

Use this parameter to initialize the project with a module. The two available options are Admin Panel and Sales.

Captcha

--captcha None

By setting this parameter to None, CAPTCHA won't be added to the project.

Push Notification (Native and Web Push)

false

--notification false

Setting this parameter to True enables native push notification using firebase and APN for Androiod, iOS and macOS apps alongside with Web Push for Web Browsers.

Sample

false

--sample false

Use this parameter to initialize the project with a sample pages. Checkout demo sample at Todo.

Windows

true

--windows

If you set the windows parameter to false, the Maui project will still be created, but no separate Windows application will be included.

Sentry

false

--sentry false

Adding --sentry true parameter to the dotnet new command allows you to capture errors, crashes, and analytics data seamlessly across all supported platforms.

AppInsights

false

--appInsights false

To enable Azure Application Insights for both server and client-side applications (including web), set the appinsights parameter to true. This option will configure the application to store logs such as errors and informational messages.

SignalR

false

--signalR false

Enabling this parameter will include sample code for SignalR, which can be used to implement real-time functionalities, such as chat, in your Blazor project.

Note:
This setting does not affect the enabling or disabling of Blazor Server.

Offline Database

false

--offlineDb false

Setting this parameter to True enables SQLite and Entity Framework Core, allowing for the development of an offline-capable cross platform application.

Warning: It is advisable to use this option only when necessary, as integrating Entity Framework Core can increase application size and potentially reduce startup performance.

Visual Studio

Note: In second window of create new project modal, make sure to check Place solution and project in the same directory checkbox.

Project structure

Run project