README
¶
Kvetch
Kvetch is a small gRPC wrapper around the Badger key-value datastore
Quickstart
Run the Kvetch container in Docker:
docker run --rm -v $PWD/data:/data -e DATASTORE=/data -p 7777:7777 syncromatics/kvetch:v0.5.1
Interact with Kvetch using kvetchctl:
GO111MODULE=on go get github.com/syncromatics/kvetch/cmd/kvetchctl@v0.5.1
export KVETCHCTL_ENDPOINT=localhost:7777 # host:port of Kvetch instance
kvetchctl set example/1 "first value"
kvetchctl set example/2 "second value"
kvetchctl set example/3 "third value"
kvetchctl get --prefix example/
It is also possible to run both kvetch and kvetchctl in the same docker container:
docker run -it --rm syncromatics/kvetch:v0.5.1 bash
DATASTORE=/data ./kvetch &
export KVETCHCTL_ENDPOINT=localhost:7777
./kvetchctl set example/1 "first value"
./kvetchctl set example/2 "second value"
./kvetchctl set example/3 "third value"
./kvetchctl get --prefix example/
More kvetchctl documentation is available in docs/kvetchctl
Building
Building Kvetch requires the following:
- Docker
- gogitver
To build and test the Kvetch Docker image alone:
make test
To build and package kvetchctl:
make package
To update generated code and documentation:
make generate
Code of Conduct
We are committed to fostering an open and welcoming environment. Please read our code of conduct before participating in or contributing to this project.
Contributing
We welcome contributions and collaboration on this project. Please read our contributor's guide to understand how best to work with us.
License and Authors
GMV Syncromatics Engineering
This software is made available by GMV Syncromatics Engineering under the MIT license.
Directories