init :-)

Author: kuldeepkeshwar

README.md

@@ -1 +1,26 @@
-# github-db
+# A key value store using Github.
+
+## Usage
+
+```
+const GithubDb=require("github-db");
+
+const db= GithubDb({db:"test-db",token:"test"}); 
+(async function(){
+    try {
+        const id=await db.add("user",{name:"John"});
+        console.log("added user", id);
+
+        const id2=await db.add("user",{name:"Will"});
+        console.log("added user", id2);
+
+        const user=await db.fetchOne("user",id);
+        console.log("fetched user", user);
+        const users=await db.fetchAll("user");
+        console.log("fetched users", users);
+    } catch (error) {
+        console.error(error);
+    }
+})()
+```
+

index.js

@@ -0,0 +1,33 @@
+const axios= require("axios");
+
+const url= `https://github-db.glitch.me/db/api`;
+
+function Client({db,token}){
+    const options={db,token};
+    let validated=false;
+    async function validate(){
+        if(!validated){
+            const {data}=await axios.get(`${url}/validate`,{params:options});
+            validated=data.valid
+        }
+    }
+    async function add(document,payload){
+        await validate();
+        const resp=await axios.post(`${url}/add`,{db:options.db,token,document,payload});
+        return resp.data.identifier;
+    }
+    async function fetchOne(document,identifier){
+        await validate();
+        const resp=await axios.get(`${url}/fetchOne`,{params:{db:options.db,token,document,identifier}});
+        return resp.data;
+    }
+    async function fetchAll(document){
+        await validate();
+        const resp=await axios.get(`${url}/fetchAll`,{params:{db:options.db,token,document}});
+        return resp.data;
+    }
+    return {
+        add,fetchOne,fetchAll
+    }
+}
+module.exports= Client;

package.json

@@ -0,0 +1,22 @@
+{
+  "name": "github-db",
+  "version": "1.0.0",
+  "description": "a key value database ",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kuldeepkeshwar/github-db.git"
+  },
+  "author": "kuldeepkeshwar",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kuldeepkeshwar/github-db/issues"
+  },
+  "homepage": "https://github.com/kuldeepkeshwar/github-db#readme",
+  "dependencies": {
+    "axios": "^0.19.0"
+  }
+}

test.js

@@ -0,0 +1,20 @@
+
+const GithubDb=require("github-db");
+
+const db= GithubDb({db:"test-db",token:"test"}); 
+(async function(){
+    try {
+        const id=await db.add("user",{name:"John"});
+        console.log("added user", id);
+
+        const id2=await db.add("user",{name:"Will"});
+        console.log("added user", id2);
+
+        const user=await db.fetchOne("user",id);
+        console.log("fetched user", user);
+        const users=await db.fetchAll("user");
+        console.log("fetched users", users);
+    } catch (error) {
+        console.error(error);
+    }
+})()

yarn.lock

@@ -0,0 +1,35 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+axios@^0.19.0:
+  version "0.19.0"
+  resolved "https://registry.yarnpkg.com/axios/-/axios-0.19.0.tgz#8e09bff3d9122e133f7b8101c8fbdd00ed3d2ab8"
+  integrity sha512-1uvKqKQta3KBxIz14F2v06AEHZ/dIoeKfbTRkK1E5oqjDnuEerLmYTgJB5AiQZHJcljpg1TuRzdjDR06qNk0DQ==
+  dependencies:
+    follow-redirects "1.5.10"
+    is-buffer "^2.0.2"
+
+debug@=3.1.0:
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/debug/-/debug-3.1.0.tgz#5bb5a0672628b64149566ba16819e61518c67261"
+  integrity sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==
+  dependencies:
+    ms "2.0.0"
+
+[email protected]:
+  version "1.5.10"
+  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.5.10.tgz#7b7a9f9aea2fdff36786a94ff643ed07f4ff5e2a"
+  integrity sha512-0V5l4Cizzvqt5D44aTXbFZz+FtyXV1vrDN6qrelxtfYQKW0KO0W2T/hkE8xvGa/540LkZlkaUjO4ailYTFtHVQ==
+  dependencies:
+    debug "=3.1.0"
+
+is-buffer@^2.0.2:
+  version "2.0.3"
+  resolved "https://registry.yarnpkg.com/is-buffer/-/is-buffer-2.0.3.tgz#4ecf3fcf749cbd1e472689e109ac66261a25e725"
+  integrity sha512-U15Q7MXTuZlrbymiz95PJpZxu8IlipAp4dtS3wOdgPXx3mqBnslrWU14kxfHB+Py/+2PVKSr37dMAgM2A4uArw==
+
+[email protected]:
+  version "2.0.0"
+  resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
+  integrity sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g=