Giter Club home page Giter Club logo

leafy-db's Introduction

Leafy-db

Use github as database. Powered by git api. Only one dependency: [email protected] || 3.x

Instalation

yarn add leafy-db

or

npm i leafy-db

Setup

  1. Create private repository on github
  2. Create personal access token with "Read/Write access to code and commit statuses" on created repo
  3. Use the following code snippet:
import { LeafyManager, Github } from "leafy-db";

const database = LeafyManager({
  repository: Github(process.env.DB_REPO),
  token: process.env.DB_TOKEN,
});

const tables = {
  users: database.table<{ name: string }>("users.json"),
};

database.connect().then(() => {
  tables.users.get("admin").name // Get is sync because values stores in cache
  
  tables.users.set("admin", {name: "newname"}) // Returns promise that will expire after 60 seconds by default. That needed to decrease commit count.
})

Gitlab support?

The only one problem with gitlab is that i have no idea how to test if repo exists. If you want to use my wrapper with gitlab, tell me, ill fix that. All other things to integrate are done already!

leafy-db's People

Contributors

leaftail1880 avatar

Watchers

 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.