github-gist-database

Welcome to Github-Gist-DB 👋

Unlimited GitHub Gist DB is a lightweight NoSQL database package for Node.js, designed to store JSON data in GitHub Gists, providing CRUD operations and more. Because it depends on the gists and Github says that you can create an unlimted gists and unlimited requests 🤑 for free.

🏠 Homepage

Table of Contents

• Installation
• Usage
• Learn
  • Create Method
  • Find Many Method
  • FindFirst Method
  • FindByIdAndUpdate Method
  • FindOneAndUpdate Method
  • FindByIdAndDelete Method
  • FindOneAndDelete Method
• Author
• Contributing
• Show your support
• License

Install

npm install github-gist-database

Usage

import { DB } from "github-gist-database";


// Define your Schema
const productSchema = new DB(
  {
    name: "String",
    price: "Number",
  },
  {
    githubToken: process.env.GITHUB_ACCESS_TOKEN!,
    schemaName: "productSchema",
    projectName: "test",
    gistId: "48ec463b54be5973729a108297860555",
    timeStamps: true,
  }
);




// Example usage
(async () => {
  const product = await productSchema.create({
    name: "laptop lenovo",
    price: 500,
  });
  console.log(product);

  const updatedProduct = await productSchema.findOneAndUpdate(
    { name: "iphone 15 pro max" },
    { name: "laptop Dell", price: 800 }
  );
  console.log(updatedProduct);

  const deletionStatus = await productSchema.findByIdAndDelete(
    "33a66454-fc9a-4016-bc01-45731fc16be3"
  );
  console.log(deletionStatus);
})();

Learn

First you have to define the Schema (the body of your database)

import { DB } from "github-gist-database";

// Define your schema
interface Product {
  name: string;
  price: number;
}

// Initialize the database
const productSchema = new DB<Product>(
  {
    name: "String",
    price: "Number",
  },
  {
    githubToken: process.env.GITHUB_ACCESS_TOKEN!,
    schemaName: "productSchema",
    projectName: "test",
    gistId: "48ec463b54be5973729a108297860555",
    timeStamps: true,
  }
);
1`
 {
    name: "String",
    price: "Number",
  },
  this is the fields and its types of your database
  you can define many fields as you want.
  And here is the types you can create with
    | "String"
    | "Number"
    | "Boolean"
    | "Object"
    | "Array"
    | "Undefined"
    | "Null"
    | "Symbol"
    | "BigInt"
`;

2. githubToken: process.env.GITHUB_ACCESS_TOKEN!. your github access token you can create it in you Developer Settings

Only Check Gist

And then click Generate Token

This is your github Token

timeStamps: true 3. timeStamps: true, will add CreatedAt and updatedAT in your schema. whenever you create a new Document Example (new product) Example createdAt: '2024-03-04T12:35:52.641Z', updatedAt: '2024-03-04T12:35:52.643Z'

Create Method

const product = await productSchema.create({
  name: "laptop lenovo",
  price: 500,
});
console.log(product);
/*
  {
  name: 'laptop lenovo',
  price: 500,
  id: '16f1a00f-5527-4783-a966-29355aa5a9de',
  createdAt: '2024-03-04T12:35:52.641Z',
  updatedAt: '2024-03-04T12:35:52.643Z'
  }
  */

FindMany Method

console.log(await productSchema.findMany());
/*
  [
  {
    name: 'laptop lenovo',
    price: 500,
    id: '29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7',
    createdAt: '2024-03-04T13:30:25.984Z',
    updatedAt: '2024-03-04T13:30:25.986Z'
  },
  {
    name: 'laptop lenovo',
    price: 500,
    id: '479a474b-a668-4407-8543-adcae24d9f91',
    createdAt: '2024-03-04T13:31:08.447Z',
    updatedAt: '2024-03-04T13:31:08.449Z'
  }
]
  */

FindFirst Method

console.log(await productSchema.findMany());
/*
  [
  {
    name: 'laptop lenovo',
    price: 500,
    id: '29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7',
    createdAt: '2024-03-04T13:30:25.984Z',
    updatedAt: '2024-03-04T13:30:25.986Z'
  },
  {
    name: 'laptop lenovo',
    price: 500,
    id: '479a474b-a668-4407-8543-adcae24d9f91',
    createdAt: '2024-03-04T13:31:08.447Z',
    updatedAt: '2024-03-04T13:31:08.449Z'
  }
]
  */

FindByIdAndUpdate Method

console.log(
  await productSchema.findByIdAndUpdate(
    "29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7",
    { name: "laptop Dell", price: 800 }
  )
);
/*
Before:
  {
    "name": "laptop lenovo",
    "price": 500,
    "id": "29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7",
    "createdAt": "2024-03-04T13:30:25.984Z",
    "updatedAt": "2024-03-04T13:30:25.986Z"
  }

  After:
  {
  name: 'laptop Dell',
  price: 800,
  id: '29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7',
  createdAt: '2024-03-04T13:30:25.984Z',
  updatedAt: '2024-03-05T21:54:15.440Z'
  }
  */

FindOneAndUpdate Method

console.log(
  await productSchema.findByIdAndUpdate(
    "29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7",
    { name: "laptop Dell", price: 800 }
  )
);
/*
Before:
  {
  name: 'laptop Dell',
  price: 800,
  id: '29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7',
  createdAt: '2024-03-04T13:30:25.984Z',
  updatedAt: '2024-03-05T21:54:15.440Z'
  }

  After:
  {
  name: 'laptop Dell 2',
  price: 800,
  id: '29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7',
  createdAt: '2024-03-04T13:30:25.984Z',
  updatedAt: '2024-03-05T21:58:24.302Z'
  }
  */

FindByIdAndDelete Method

console.log(
  await productSchema.findByIdAndUpdate(
    "29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7",
    { name: "laptop Dell", price: 800 }
  )
);
/*
Before:
  {
    name: 'laptop Dell 2',
    price: 800,
    id: '29ad41de-b015-4d96-a9d4-1a5c5a4a4ec7',
    createdAt: '2024-03-04T13:30:25.984Z',
    updatedAt: '2024-03-05T21:58:24.302Z'
  }

  After:
 Response "Ok"
  */

FindOneAndDelete Method

  console.log(
    await productSchema.findOneAndDelete({id:"479a474b-a668-4407-8543-adcae24d9f91"})
  );
/*
Before:
  {
    "name": "laptop lenovo",
    "price": 500,
    "id": "479a474b-a668-4407-8543-adcae24d9f91",
    "createdAt": "2024-03-04T13:31:08.447Z",
    "updatedAt": "2024-03-04T13:31:08.449Z"
  }

  After:
 Response "Ok"
  */

Author

👤 ElTahawy

• Website: https://tahawy.vercel.app/
• Github: @tahawy111
• LinkedIn: @amer-eltahawy

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2024 Amer Eltahawy.
This project is MIT licensed.

---