Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1010 Bytes

README.md

File metadata and controls

27 lines (18 loc) · 1010 Bytes

Micro KVP

A lightweight KVP implementation, you can attach to any persistent storage.

Works with MySql or MariaDB, so you can host on cPanel or as containerised app.

There's no user-interface, application management is available entirely via simple REST APIs.

Basic Concept

Using the ADMIN_TOKEN, you can create an App. Each App will have a unique APP_TOKEN. Using the APP_TOKEN you can create, update, delete keys. A key can hold any value. Key names are unique per App. You can perform list, get, store, increment, and decrement operations on keys.

Use Cases

  • You've built a wordpress plugin, and wish to store certain consuption data in such a way that i can't be deleted

REST APIs

APIs are divided in two parts. One to manage apps and second to manage keys associated to any given app. Documentation is available in openapi.yaml

Deployment Instructions

  • Copy .env.example to .env, and replace all environment variables

... TBD ...

Enjoy!