SapphireDb
SapphireDb Server, a self-hosted, easy to use realtime database for Asp.Net Core and EF Core
File Explorer
Download Latest Version (.zip)- docker-image.yml
- FUNDING.yml
- .gitignore
- ActionHandlerBase.cs
- ActionAuthAttribute.cs
- AuthAttributeBase.cs
- CreateAuthAttribute.cs
- CreateEventAttribute.cs
- DefaultQueryAttribute.cs
- DeleteAuthAttribute.cs
- DeleteEventAttribute.cs
- DisableAutoMergeAttribute.cs
- DisableCreateAttribute.cs
- DisableDeleteAttribute.cs
- DisableQueryAttribute.cs
- DisableUpdateAttribute.cs
- ICompilableAttribute.cs
- InvokableAttribute.cs
- MergeConflictResolutionModeAttribute.cs
- ModelStoreEventAttributeBase.cs
- NonCreatableAttribute.cs
- QueryAttribute.cs
- QueryAttributeBase.cs
- QueryAuthAttribute.cs
- QueryEntryAuthAttribute.cs
- UpdateableAttribute.cs
- UpdateAuthAttribute.cs
- UpdateEventAttribute.cs
- ConnectionResponse.cs
- WrongApiResponse.cs
- CreateRangeCommand.cs
- CreateRangeCommandHandler.cs
- CreateRangeResponse.cs
- DeleteRangeCommand.cs
- DeleteRangeCommandHandler.cs
- DeleteRangeResponse.cs
- ErrorCommand.cs
- ErrorCommandHandler.cs
- ExecuteCommand.cs
- ExecuteCommandHandler.cs
- ExecuteResponse.cs
- ExecuteCommandsCommand.cs
- ExecuteCommandsCommandHandler.cs
- ExecuteCommandsResponse.cs
- InvokeCommand.cs
- InvokeCommandHandler.cs
- InvokeResponse.cs
- MessageCommand.cs
- MessageCommandHandler.cs
- MessageResponse.cs
- PublishCommand.cs
- PublishCommandHandler.cs
- IQueryCommand.cs
- QueryCommand.cs
- QueryCommandHandler.cs
- QueryResponse.cs
- QueryQueryCommand.cs
- QueryQueryCommandHandler.cs
- CompleteStreamCommand.cs
- CompleteStreamCommandHandler.cs
- InitStreamResponse.cs
- StreamCommand.cs
- StreamCommandHandler.cs
- ChangeResponse.cs
- SubscribeCommand.cs
- SubscribeCommandHandler.cs
- SubscribeMessageCommand.cs
- SubscribeMessageCommandHandler.cs
- TopicResponse.cs
- SubscribeQueryCommand.cs
- SubscribeQueryCommandHandler.cs
- UnsubscribeCommand.cs
- UnsubscribeCommandHandler.cs
- UnsubscribeMessageCommand.cs
- UnsubscribeMessageCommandHandler.cs
- UpdateRangeCommand.cs
- UpdateRangeCommandHandler.cs
- UpdateRangeResponse.cs
- CollectionCommandBase.cs
- CommandBase.cs
- CommandHandlerBase.cs
- ICommandHandler.cs
- INeedsConnection.cs
- ResponseBase.cs
- SapphireDbErrorResponse.cs
- ValidatedResponseBase.cs
- PollConnection.cs
- PollMiddleware.cs
- SSEConnection.cs
- SSEMiddleware.cs
- WebsocketConnection.cs
- WebsocketHelper.cs
- WebsocketMiddleware.cs
- ConnectionBase.cs
- ConnectionManager.cs
- MessageSubscriptionManager.cs
- RestMiddleware.cs
- SapphireChangeNotifier.cs
- SapphireMessageSender.cs
- SubscriptionManager.cs
- SapphireDatabaseBuilder.cs
- SapphireDatabaseExtension.cs
- ActionHelper.cs
- AuthHelper.cs
- CollectionChangeHelper.cs
- CollectionHelper.cs
- DateTimeHelper.cs
- DbContextHelper.cs
- ExpressionHelper.cs
- JsonHelper.cs
- MessageTopicHelper.cs
- ModelHelper.cs
- QueueHelper.cs
- ReflectionMethodHelper.cs
- SapphireAuthenticationHelper.cs
- SapphireStreamHelper.cs
- StringHelper.cs
- SubstitutionExpressionVisitor.cs
- ValidationHelper.cs
- CountPrefilter.cs
- FirstPrefilter.cs
- IAfterQueryPrefilter.cs
- IncludePrefilter.cs
- IPrefilter.cs
- IPrefilterBase.cs
- OrderByPrefilter.cs
- SelectPrefilter.cs
- SkipPrefilter.cs
- TakePrefilter.cs
- ThenOrderByPrefilter.cs
- WherePrefilter.cs
- ActionMapper.cs
- CommandExecutor.cs
- DbContextAccesor.cs
- DbContextTypeContainer.cs
- DIHelper.cs
- ActionHandlerNotFoundException.cs
- ActionNotFoundException.cs
- CollectionNotFoundException.cs
- CommandHandlerNotFoundException.cs
- DeleteRejectedException.cs
- IncludeNotAllowedException.cs
- MethodNotFoundException.cs
- MissingRealtimeConnectionException.cs
- NavigationPropertyNotFoundException.cs
- NotInvokableException.cs
- OperationDisabledException.cs
- QueryNotFoundException.cs
- SapphireDbException.cs
- SelectNotAllowedException.cs
- UnauthorizedException.cs
- UnhandledException.cs
- UpdateRejectedException.cs
- ValueNotFoundException.cs
- WrongActionFormatException.cs
- WrongConditionOrderException.cs
- WrongQueryFormatException.cs
- WrongReturnTypeException.cs
- ISapphireActionConfiguration.cs
- ISapphireModelConfiguration.cs
- SapphireActionBuilder.cs
- SapphireActionHandlerBuilder.cs
- SapphireModelBuilder.cs
- SapphireOrderedQueryBuilder.cs
- SapphirePropertyBuilder.cs
- SapphireQueryBuilder.cs
- SapphireQueryBuilderBase.cs
- SapphireReducedQueryBuilder.cs
- ActionAttributesInfo.cs
- ActionHandlerAttributesInfo.cs
- CollectionSubscriptionsContainer.cs
- ExecutionContext.cs
- HttpInformation.cs
- ModelAttributesInfo.cs
- PrefilterContainer.cs
- PropertyAttributesInfo.cs
- SapphireAuthResource.cs
- SapphireDatabaseOptions.cs
- SapphireOfflineEntity.cs
- StreamContainer.cs
- Subscription.cs
- FolderProfile.pubxml
- SendChangesRequest.cs
- SendMessageRequest.cs
- SendPublishRequest.cs
- SyncContext.cs
- SyncRequest.cs
- ISapphireSyncModule.cs
- SyncManager.cs
- .gitignore
- ISapphireDatabaseNotifier.cs
- SapphireDatabaseNotifier.cs
- SapphireDb.csproj
- SapphireDb.snk
- SapphireDbContext.cs
- .gitignore
- HttpSyncConfiguration.cs
- README.md
- SapphireDb.HttpSync.csproj
- SapphireDb.HttpSync.snk
- SapphireHttpSyncExtension.cs
- SapphireHttpSyncMiddleware.cs
- SapphireHttpSyncModule.cs
- .gitignore
- README.md
- RedisStore.cs
- RedisSyncConfiguration.cs
- SapphireDb.RedisSync.csproj
- SapphireDb.RedisSync.snk
- SapphireRedisSyncExtension.cs
- SapphireRedisSyncModule.cs
- dotnet-tools.json
- ExampleActions.cs
- MessageActions.cs
- UserActions.cs
- UserActionsConfiguration.cs
- AccountController.cs
- DemoController.cs
- UserController.cs
- Base.cs
- CustomFunctionForQuery.cs
- CustomFunctionPerEntryForQuery.cs
- QueryFields.cs
- RequiresAdminForQuery.cs
- RequiresAuthForQuery.cs
- UpdateExample.cs
- AppUser.cs
- DemoEntry.cs
- Document.cs
- EventDemo.cs
- EventDemoDerived.cs
- IncludeDemoUser.cs
- IncludeDemoUserEntry.cs
- Log.cs
- Message.cs
- MessageConfiguration.cs
- Pixel.cs
- QueryFunctionDemo.cs
- ServerSideQueryWithDefault.cs
- ServerSideQueryWithDefaultBase.cs
- ValidationDemo.cs
- Base.cs
- Config.cs
- Log.cs
- Message.cs
- Test.cs
- User.cs
- LoginViewModel.cs
- NewAppUserViewModel.cs
- AuthDemoContext.cs
- DemoContext.cs
- RealtimeContext.cs
- Seeder.cs
- Security.cs
- launchSettings.json
- .gitignore
- appsettings.json
- appsettings.NLB1.json
- appsettings.pg.json
- appsettings.Redis.json
- JwtIssuer.cs
- JwtOptions.cs
- Program.cs
- Startup.cs
- StringHelper.cs
- web.config
- WebUI.csproj
- WebUI.csproj.user
- .gitignore
- UserControllerTests.cs
- WebUI.Tests.csproj
- .dockerignore
- .gitignore
- .travis.yml
- Dockerfile
- icon.png
- LICENSE
- README-NUGET.md
- README.md
- WebUI.sln
# Installation Guide
1. Get the code
git clone https://github.com/SapphireDb/SapphireDb
Downloads the entire project code from GitHub to your computer.
cd SapphireDb
Moves into the project folder you just downloaded.
2. Docker
Easy RecommendedPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t sapphiredb .
Builds a runnable image based on the Dockerfile.
docker run -p 8080:80 sapphiredb
Runs the built image as an actual container.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
3. .NET
MediumPrerequisites
cd SapphireDb.HttpSync
This project's files live in a subfolder, so move into it first.
dotnet restore
Downloads the packages the project depends on.
dotnet run
Builds the project and runs it immediately.
After dotnet run, check the message or address shown in the terminal.
// repository documentation
Was this content helpful?
(0 ratings)