Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gcaufy/freedb.js
Git based key value database. javascript library
https://github.com/gcaufy/freedb.js
Last synced: about 1 month ago
JSON representation
Git based key value database. javascript library
- Host: GitHub
- URL: https://github.com/gcaufy/freedb.js
- Owner: Gcaufy
- Created: 2019-07-02T05:03:29.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-01T08:55:06.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T07:55:35.526Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 3.93 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# freedb
A lightweight solution to use a cloud Key-Value database based on github.com.
## Install
```
npm install freedb --save
```
## Building
See [BUILD.md](BUILD.md).
## Usage
```
import Free from 'freedb';
const kv = new Free.KV({
// This is my public test account and token, only used for test and CI.
// If you want to have your own database,
// Then you need to create a repository and generate a token.
host: '[email protected]:Gcaufy-Test/test-database.git',
token: 'your_github_repo_token'
});
kv.set('mykey', 'myvalue').then(res => {
console.log(res.raw_url);
});
```
## How to generate a token
1. Create or use your own github.com account and login.
2. Go to: Settings -> Developer settings -> Personal access tokens -> Generate new token
3. Select scopes: "repo" to make sure you grant access.
## API:
* Create a KV instance
new Free.KV(option: DataBaseOption):
```
DataBaseOption {
// host: github clone links, support both https/ssh links
host: string;
// token: OAuth token, make sure you have read/write access for the repo
token: string;
// db: Basiclly it's a directory, default value is "default"
db?: string;
// branch: git branch, default value is "master"
branch?: string;
// cipher: if is a string, then treat as a secret key for aes192 for both key and value. or you can customize a encryt and decrypt function
cipher?: CipherOption | string;
// debug: show action log or not.
debug?: boolean;
}
CipherOption {
// secret key for encrypt
secret: string;
// customize encrypt algorithm, default value is ase192 encrypt algorithm
encode: (str: string): string;
// customize decrypt algorithm, default value is ase192 decrypt algorithm
decode: (str: string): string;
}
```
* KV instance methods
1. use(db: string): void
Switch database. can be a non-exist database.
2. keys(): Promise
List all keys in current database;
3. exist(key: string): Promise
Check a key exist or not in current database;
4. get(key: string): Promise
Get a key record in current database;
5. set(key: string, value: string): Promise
Set a value for a key. Will create a key if a key do not exist;
6. append(key: string): Promise
Append a value for a key. Will create a key if a key do not exist;
```
KeyRecord {
// Key content
content?: string;
// Key name
name?: string;
// Key content size, if the key do not exist, then size = -1
size?: number;
// Key git raw url
raw_url?: string;
// Key git html url
html_url?: string;
// Key git commit hash if there is
commit?: string;
}
```
## How to protect your data
There are two way to protect your data.
1. Encrypt you key and value in `CipherOption`
```
new GitDB.KV({
host: '[email protected]:Gcuafy-Test/test-database',
token: 'mytoken',
cipher: {
secret: 'my secret key',
// Default value is using ase192 encrypt algorithm
encode (str) {
return MyEncryptMethod(str);
},
// Default value is using ase192 decrypt algorithm
decode (str) {
return MyDecryptMethod(str);
}
}
})
```
2. Make the repository private.
Simply and easy. Github support private repository