go-kvstore

In-memory key-value database This is a simple, in-memory key-value store and queue server written in Go. It supports basic key-value operations and a simple queue system. The server listens on port 8080 and accepts HTTP POST requests with JSON payloads. A frontend is also provided, built with React.

Usage

Running the server

To run the server, navigate to the cmd/go-kvstore directory and run:

go run main.go

The server will start listening on port 8080.

Running the frontend

To run the frontend in development mode, navigate to the /frontend directory and run:

npm install
npm start

The frontend will be available at http://localhost:3000.

Building the frontend for production

To create a production build of the frontend, navigate to the /frontend directory and run:

npm run build

To serve the production build, first install the serve package globally:

npm install -g serve

Then, navigate to the /frontend/build directory and start the static file server:

serve -s .

The frontend will be available at http://localhost:3000 or another port assigned by serve.

API

The server accepts HTTP POST requests at the /api endpoint with the following JSON payload:

{
    "command": "COMMAND_NAME ARG1 ARG2 ..."
}

Replace COMMAND_NAME with the desired command and provide the required arguments.

Supported Commands

SET key value [EX seconds] [NX|XX]: Sets the value for the given key. Optional flags:
    EX seconds: Set a timeout for the key in seconds.
    NX: Set the value only if the key does not exist.
    XX: Set the value only if the key already exists.
GET key: Returns the value associated with the given key.
QPUSH key value1 value2 ...: Pushes values to the queue with the given key.
QPOP key: Pops and returns the first value from the queue with the given key.
BQPOP key timeout: Pops and returns the first value from the queue with the given key, waiting up
to timeout seconds if the queue is empty.

Example Requests

Here are some example requests using curl:

Set a key-value pair

curl -X POST -H "Content-Type: application/json" -d '{"command": "SET key1 value1"}' http://localhost:8080/api/commands

Get the value for a key

curl -X POST -H "Content-Type: application/json" -d '{"command": "GET key1"}' http://localhost:8080/api/commands

Push values to a queue

curl -X POST -H "Content-Type: application/json" -d '{"command": "QPUSH queue1 value1 value2 value3"}' http://localhost:8080/api/commands

Pop a value from a queue

curl -X POST -H "Content-Type: application/json" -d '{"command": "QPOP queue1"}' http://localhost:8080/api/commands

Blocking pop from a queue with a timeout

curl -X POST -H "Content-Type: application/json" -d '{"command": "BQPOP queue1 10"}' http://localhost:8080/api/commands

Testing

To run the tests for the API package, navigate to the pkg/api and do go test