Skip to content
SapphireDb Server, a self-hosted, easy to use realtime database for Asp.Net Core and EF Core
C#
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update FUNDING.yml Dec 5, 2019
.idea finished streaming to server Feb 7, 2020
SapphireDb renamed changerespones to changesresponse Feb 16, 2020
WebUI added support for redis cache for syncing Feb 8, 2020
.gitignore work on include prefilter Dec 22, 2019
.travis.yml fixed build Dec 4, 2019
LICENSE updated LICENSE Nov 13, 2019
README-NUGET.md updated readme Feb 15, 2020
README.md updated readme Feb 15, 2020
WebUI.sln renamed project to sapphiredb Nov 29, 2019
icon.png added icon to project Dec 22, 2019

README.md

SapphireDb - Server for Asp.Net Core Build Status

SapphireDb logo

SapphireDb is a self-hosted, easy to use realtime database for Asp.Net Core and EF Core.

It creates a generic API you can easily use with different clients to effortlessly create applications with realtime data synchronization. SapphireDb should serve as a self hosted alternative to firebase realtime database and firestore on top of .Net.

Check out the documentation for more details: Documentation

Features

  • 🔧 Dead simple configuration
  • 📡 Broad technology support
  • 💻 Self hosted
  • 💾 Easy to use CRUD operations
  • ⚡️ Model validation
  • ✔️ Database support
  • 📂 Supports joins/includes
  • Complex server evaluated queries
  • 🔌 Actions
  • 🔑 Authorization included
  • ✉️ Messaging
  • 🌐 Scalable

Learn more

Installation

Install package

To install the package execute the following command in your package manager console

PM> Install-Package SapphireDb

You can also install the extension using Nuget package manager. The project can be found here: https://www.nuget.org/packages/SapphireDb/

Configure DbContext

You now have to change your DbContext to derive from SapphireDbContext. Also make sure to adjust the constructor parameters.

// Change DbContext to SapphireDbContext
public class MyDbContext : SapphireDbContext
{
  //Add SapphireDatabaseNotifier for DI
  public MyDbContext(DbContextOptions<MyDbContext> options, SapphireDatabaseNotifier notifier) : base(options, notifier)
  {

  }

  public DbSet<User> Users { get; set; }

  public DbSet<Test> Tests { get; set; }
}

Register services and update pipeline

To use the SapphireDb you also have to make some changes in your Startup.cs-File.

public class Startup
{
  public void ConfigureServices(IServiceCollection services)
  {
    //Register services
    services.AddSapphireDb(...)
      .AddContext<MyDbContext>(cfg => ...);
  }

  public void Configure(IApplicationBuilder app)
  {
    //Add Middleware
    app.UseSapphireDb();
  }
}

Examples

Server

AspNet Core Example

Client

React Example

Svelte Example

NodeJs Example

Angular Example

Documentation

Check out the documentation for more details: Documentation

Implementations

Server

SapphireDb - Server for Asp.Net Core

Client

sapphiredb - JS client (JS, NodeJs, React, Svelte, ...)

ng-sapphiredb - Angular client

Author

Morris Janatzek (morrisjdev)

Licenses

SapphireDb - MIT License

sapphiredb-js - MIT License

You can’t perform that action at this time.