https://github.com/brittonhayes/minikv

A mini key value store built with Go + Gorilla Mux + BoltDB 🐹
https://github.com/brittonhayes/minikv

Last synced: about 1 month ago
JSON representation

A mini key value store built with Go + Gorilla Mux + BoltDB 🐹

• Host: GitHub
• URL: https://github.com/brittonhayes/minikv
• Owner: brittonhayes
• Created: 2021-04-07T09:51:38.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-04T00:56:50.000Z (over 1 year ago)
• Last Synced: 2024-06-20T13:31:50.091Z (5 months ago)
• Language: Go
• Size: 17.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# minikv

> A mini key value store built with Go + Gorilla Mux + BoltDB

## ⚡ Usage

### 🐋 Docker (Recommended)

**Size**: `6.5 MB` 🔬

Fetch the Docker container and start the KV store. The Docker image is only `~6.5MB` in size. Thanks to a scratch

container, and some helpful go build tags that remove excess information from the binary.

```shell

docker run -d --rm bjhayes/minikv:latest -p 8080:8080

```

```shell

# Using a custom port

docker run -d --rm bjhayes/minikv:latest -e PORT=":9090" -p 9090:9090

```

### 🇼 Hashicorp Waypoint

Build the docker image, tag it, and deploy it to your local environment, Kubernetes, or AWS. Just tweak

the [waypoint.hcl](./waypoint.hcl) to your needs!

```shell

make waypoint

```

### 🐹 Go

**Size**: `6.2 MB` 🔬

Compile and run the Go executable

```shell

# Install with go get

go get github.com/brittonhayes/minikv/cmd/minikv

minikv

```

```shell

# Compile from source

make compile

./bin/minikv

```

## ✨ Try it out

```shell

# Ping the minikv to see if it's up

curl http://localhost:8080/status/health

# Add an entry

curl -d '{"name":"bob"}' http://localhost:8080/mykey

# Read an entry

curl http://localhost:8080/mykey

```