JSPM

@getanthill/datastore

0.1.9
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 208
  • Score
    100M100P100Q107635F
  • License MIT

Event-Sourced Datastore

Package Exports

  • @getanthill/datastore

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@getanthill/datastore) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

getanthill Datastore

pipeline Quality Gate Status

Coverage Security Rating Reliability Rating

Purpose

This project aims to help developers deploying state-of-the-art Event-Source data models in a unified and standardized way. The Datastore is composed of several parts:

  1. A RESTful API
  2. A SDK to consume this API
  3. A Backoffice to manage data

RESTful API

The RESTful API is fully compliant Open API 3.0. It is exposing standardized routes for models managed by the Datastore such as create, update, etc.

Administrators can access routes dedicated to the Datastore administration on /api/admin once the environment variable flag FEATURE_API_ADMIN=true.

SDK

The SDK is a simple HTTP client helping developers to consume the Datastore APIs from the code. The SDK is for now only available at a low level and in Javascript.

Because the API is Open API 3.0 compliant, any code generator can be used to get a client in your prefered language:

https://openapi-generator.tech/docs/generators

Backoffice

The Backoffice is a User Interface to manage data in your Datastore. To activate this feature, you must set the environment variable flag FEATURE_BACKOFFICE=true.

Full Documentation

goto Documentation