Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lucid-kv/lucid

High performance and distributed KV store w/ REST API. 🦀
https://github.com/lucid-kv/lucid

distributed-cache docker encryption key-value key-value-store kv persistence rest-api rust sse

Last synced: 9 days ago
JSON representation

High performance and distributed KV store w/ REST API. 🦀

Awesome Lists containing this project

README

        



Lucid KV



About Lucid KV



High performance and distributed KV store w/ REST API. 🦀







## Introduction

Lucid is a high performance, secure and distributed key-value store accessible through an HTTP API, that is built around a modular configuration to enable features on the fly, like persistence, encryption SSE, compression, replication, and more.

[Read the complete Medium article →](https://medium.com/@clint21/lucid-an-http-key-value-store-c0e734586e26)

## Getting Started

Get the latest binary from the [releases](https://github.com/lucid-kv/lucid/releases) page and run these commands:

```
$ ./lucid init
$ ./lucid server
```

### Docker Deployment

Or run a node with Docker, but you need to create a [lucid.yml](.github/lucid.yml) file locally before.

```
$ docker pull lucidkv/lucid
$ docker run -p 7020:7020 -v lucid.yml:/etc/lucid/lucid.yml lucidkv/lucid
```

A demonstration node is accessible at or deploy your own:


## Documentation

You can quickly start [here](https://github.com/lucid-kv/lucid/wiki) or get the complete documentation at .

## Works in Progress

You can take a look at the roadmap [here](https://github.com/lucid-kv/lucid/issues/64), we are working on the implementation of persistence and encryption.

## Command Line Interface

You can take a look at the Lucid command line at .

```
██╗ ██╗ ██╗ ██████╗██╗██████╗ ██╗ ██╗██╗ ██╗
██║ ██║ ██║██╔════╝██║██╔══██╗ ██║ ██╔╝██║ ██║
██║ ██║ ██║██║ ██║██║ ██║ ██╔═██╗ ╚██╗ ██╔╝
██████╗╚██████╔╝╚██████╗██║██████╔╝ ██║ ██╗ ╚████╔╝
╚═════╝ ╚═════╝ ╚═════╝╚═╝╚═════╝ ╚═╝ ╚═╝ ╚═══╝

A Fast, Secure and Distributed KV store with an HTTP API.
Written in Rust, Fork us on GitHub (https://github.com/lucid-kv)

FLAGS:
-h, --help Prints help information
--no-banner Disable showing the banner on start
-V, --version Prints version information

OPTIONS:
-c, --config Specify the Lucid configuration file

SUBCOMMANDS:
help Prints this message or the help of the given subcommand(s)
init Initialize Lucid and generate configuration file
server Run a new Lucid server instance
settings Manage the Lucid configuration file
```

## Web Interface (UI)

Lucid wants to propose a Web UI to manage data, issue tokens, organize nodes and configure instances.

## Development Credits

Lucid is developed by [@thisisclint21](https://github.com/thisisclint21), [@Slals](https://github.com/Slals), [@CephalonRho](https://github.com/CephalonRho), [@rigwild](https://github.com/rigwild) and published under the [MIT License](LICENSE.md).

| Name / Nickname | Twitter | Role |
|-----------------|-----------------------|--------------------|
| clint21.eth ⚡️ | @thisisclint21 | Lucid Founder |
| CephalonRho | @cephalonrho | Core Development |
| Jonathan Serra | @_blocs | Core Development |
| Rigwild | @rigwild_ | Web UI Development |

## Contribute to Lucid

See [CONTRIBUTING.md](CONTRIBUTING.md) for best practices and instructions on setting up your development environment to work on Lucid.