Giter Club home page Giter Club logo

shelfdb's Introduction

Shelf

The GraphQL database. Makes storing data easy!

Test Docker Pulls MicroBadger Size

DISCLAIMER: This project is currently in ALPHA

About

Shelf is a database written in rust and that uses GraphQL for it's api and migrations. Graphql makes it easy to describe the data resources you want to fetch. Shelf expands that power to simple let ypu describe your data and then have the persistence automatically generated for you

However what makes this database even more powerful is the ecosystem surrounding GraphQL. You dont need any specific client to access this database. All you have to do is take the GraphQL Schema and use you favourite tool to generate the client for you. You can use JavaScript, TypeScript, Java, C#, Rust, Go and probably most other languages that are out there!

The GraphQL api is compatible with both the Apollo standard and Facebooks Relay specification. Most list resources are paginated using cursor based pagination

Installation

Helm

The easiest way to add Shelfdb to you cluster is by using our helm script. Assuming you have helm installed (How to install), you can run the following command

helm install --repo https://shelfdb.netlify.com shelfdb

Docker Compose

You can also run Shelfdb locally using the following docker compose file. Really nice for some local experimentation

version: '3'
services:
  shelfdb:
    image: "joatin/shelfdb:latest"
    ports:
      - "5600:5600"

Roadmap

  • Disk File Store
  • GraphQL Resource Specifications
  • Working GraphQL API
  • GraphQL Migration Support
  • S3 File Store
  • GraphQL Subscriptions
  • Clustering

See our Contribution Guidelines

See LICENSE

shelfdb's People

Contributors

joatin avatar carrolita avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.