sapphiredb / sapphiredb-js

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

SapphireDb - Server for Asp.Net Core

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
• 📱 Offline support
• 💾 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.

// Change DbContext to SapphireDbContext
public class MyDbContext : SapphireDbContext
{
  public MyDbContext(DbContextOptions<MyDbContext> options) : base(options)
  {

  }

  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/Packages

Server

SapphireDb - Server for Asp.Net Core

SapphireDb.RedisSync

SapphireDb.HttpSync

Client

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

ng-sapphiredb - Angular client

Author

Morris Janatzek (morrisjdev)

Licenses

SapphireDb - MIT License

sapphiredb-js - MIT License

sapphiredb-js's Issues

Offline storage configuration doesn' work, it keeps using SapphireNoopStorage

It keeps saying No storage was configured. Using SapphireNoopStorage and will not store things locally..

Here's my app.modules.ts:

providers: [
  {
    provide: SAPPHIRE_DB_OPTIONS,
    useValue: {
      useSsl: true,
      offlineSupport: true,
      serverBaseUrl: "localhost:4445",
      connectionType: "websocket",
    } as SapphireDbOptions,
  },
  SapphireLocalStorage,
],

How to pass JWT Token and Validate it?

I used

db.setAuthToken('');

after this unable to connect to the websocket.

Please help

track and configure reconnect

Hi, first thanks for the nice project - currently im evaluate it for some client projects and two questions came up:
how can i configure the re-connect behavior ?
how can i track the connection state of client <-> server ?

would be nice to show some connection state indicator and reduce the reconnect time based on attempts

collection remove doesn't trigger subscription update

Hi,
when you remove an entry by collection.remove - the subscription is not triggered ( of the caller )
all other clients are correctly updated

after remove, dataCollection.count() shows the corrrect number so i guess its just a missing call of the collection subscription

Compatibility with SQLite/watermelon database as custom storage provider

@morrisjdev
can you elaborate more about implementing a custom storage provider? I m willing to do the implementation of that but need more clarification if possible