Skip to content
github-actions[bot] edited this page Nov 17, 2026 · 2 revisions

Blueprint User Manual

Blueprint is a backend application framework for .NET, designed to provide a stable, consistent API across different underlying technologies. Applications interact with Blueprint’s contracts and services, allowing infrastructure choices to evolve independently of business logic.

This manual describes the consumer API available in this repository. Examples target .NET 10 and C# 14. Start with Getting Started to add Blueprint to your project, then follow EShop - Checkout Tutorial for a complete application example.

Getting Started

  • Getting Started: add Blueprint to your project using a project or DLL reference and configure its dependencies.

Blueprint Database

  • BlueprintDatabase: understand the abstract base class, shared configuration, entity registration, and application lifetime.
  • Entities
  • Reading and Writing Data
    • Queries and CRUD: filter, sort, page, insert, update, and delete.
    • Transactions: group writes, prepare operations, validate before commit, and handle rollback or cancellation.
  • Localization
  • Caching
    • RAM Caching: cache selected tables and synchronize committed SQL changes.
  • Tutorials
    • EShop - Checkout Tutorial: create a website user, add an iPhone to the basket, and complete checkout with a transaction that saves the order, reduces stock, and clears the basket.

Background Tasks

  • Background Tasks: register work, use interval or daily schedules, and control execution.

Log

Help

  • Troubleshooting: identify common configuration, mapping, query, and transaction problems.
  • Contributing: coding style, naming rules, documentation comments, and contribution guidelines.

Reading the examples

Use using Blueprint.Database.Entities; for the static Entity API. Most examples use the Product contract from the EShop checkout tutorial and assume its registration and an active BlueprintDatabase. A page that requires another contract shows that contract explicitly.

Code blocks are independent examples unless stated otherwise. Replace sample connection strings and IDs with values for your application. All database writes should be explicit: editing a loaded object's properties does not save it automatically.

Repository overview

Clone this wiki locally