npmpackage.info

Gathering detailed insights and metrics for grud

Other packages similar to grud

@grudge/server

2.0.11

Express server for Grudge

@grudge/sdk

2.0.10

Client-side sdk for interacting with @grudge/server

@grudge/client

2.0.12

React client for Grudge

@grudge/domain

2.0.10

Grudge domain models

Gathering detailed insights and metrics for grud

grud - 1.0.12 | npmpackage.info

grud

Create, read, update and delete your JSON data store in GitHub.

1.0.12

MIT

JavaScript

26.48 kB

2,355 4.4

Installations

npm install grud

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

16.13.0

NPM Version

8.1.0 Pull Requests

Open

0

Total

0

Closed

0

Issues

Open

2

Total

2

Closed

0

Releases

Unable to fetch releases

Languages

JavaScript

JavaScript (100%)

Developer

aneesahammed

Download Statistics

Total Downloads

2,355

Last Day

Last Week

Last Month

Last Year

254

GitHub Statistics

MIT License

5 Stars

32 Commits

1 Forks

1 Watchers

1 Branches

1 Contributors

Updated on Dec 03, 2024

Bundle Size

87.44 kB

Minified

26.48 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.12

Package Id

grud@1.0.12

Unpacked Size

37.78 kB

Size

10.10 kB

File Count

NPM Version

8.1.0

Node Version

16.13.0

Total Downloads

Cumulative downloads

Total Downloads

2,355

Last Day

100%

Compared to previous day

Last Week

Compared to previous week

Last Month

-58.6%

Compared to previous month

Last Year

-7.3%

254

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

axios chalk lodash.find lodash.findindex lodash.without regenerator-runtime uuid

Dev Dependencies

@babel/cli @babel/core @babel/preset-env babel-polyfill chai mocha webpack-node-externals

Welcome to grud 👋

Simple JSON data store in GitHub with CRUD interface for React, Node, Electron and the browser.
grud is a convenient method of storing & performing read, update & delete operations on data without setting up a database server.

🏠 Homepage

Install

1npm install grud

Initialize

To get started with grud, initialize the db object by passing the required config.

1const Grud = require("grud");
2
3let config = {
4  protocol: "https",           //If not passed, defaults to 'https'
5  host: "api.github.com",      //If not passed, defaults to 'api.github.com' | In case of Enterprise-GitHub e.g github.snapcircle.net.
6  pathPrefix: "",              //Leave empty if you are using github.com | In case of Enterprise-GitHub e.g api/v3
7  owner: "username",           //Your GitHub username
8  repo: "my-repo",             //Your repository name where you'd like to have your JSON store hosted
9  path: "db.json",             //Your data store file with .json extension
10  personalAccessToken: "xxxx", //Your personal-access-token with write access
11};
12let db = new Grud(config);

Create your GitHub personal token from here.
And please note that grud will create a new JSON data store file as mentioned in the config (db.json in our case) if the file is not found.
If the file exists, data shall get appended to the collection array.

Create

Create a single record

The following query creates a single post record in your JSON dataStore (db.json).

1const data = {
2  author: "Anand",
3  title: "sunt aut facere repellat provident ",
4  body: "quia et suscipit\nsuscipit recusandae consequuntur ",
5};
6const posts = await db.save(data);

Create multiple records

The following query creates multiple post records in your defined JSON datastore.

1const data = [
2  {
3    author: "Sarath",
4    title: "sunt aut facere repellat provident ",
5    body: "quia et suscipit\nsuscipit recusandae consequuntur ",
6  },
7  {
8    author: "Anand",
9    title: "qui est esse",
10    body: "est rerum tempore vitae\nsequi sint nihil",
11  },
12];
13const posts = await db.save(data);

Read

Get record by Id or unique identifier

The following query returns a single post record by unique identifier or Id.

1const post = await db.find({ _id: "301b63faac384a31b3e785ebf40295e5" });

1const post = await db.find({ author: "Anand" });

Get all records

The following query returns all posts records.

1const posts = await db.find();

Update

Update record by Id or unique identifier.
The following query finds the post record and updates it.

1const posts = await db.update(
2  { _id: "301b63faac384a31b3e785ebf40295e5" },
3  data
4);

const posts = await db.update({ author: "Anand" }, data);

Delete

Delete a single record

The following query deletes a single post record.

1await db.deleteOne({ _id: "301b63faac384a31b3e785ebf40295e5" });

1await db.deleteOne({ author: "Anand" });

Delete all records

TBA

Run tests

1npm run test

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Show your support

Give a ⭐️ if this project helped you!

Limits

grud came out from the frequent need of having a database for internal tooling purpose.
If your priority is to have secure/high-performance storage, you should stick to traditional databases like MongoDB.

Author

👤 Anees Ahammed

Twitter: @aneesahammed

📝 License

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

SAST

Determines if the project uses static code analysis.

10

License

Determines if the project has defined a license.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.4

/10

Last Scanned on 2025-05-05

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More