About Lucid KV

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

Introduction

Lucid is currently in a development stage but we plan to make a fast, secure and distributed key-value store accessible through an HTTP API, we also want to propose Persistence, Encryption, SSE streaming, Compression, Replication and more.

Getting Started

Get the latest binary from the releases page and run these commands:

$ ./lucid init
$ ./lucid --config lucid.yml server

Or run a node with Docker, but you need to create a 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 instance is accessible at http://lucid-kv.herokuapp.com (with authentication disabled).

Documentation

You can start quickly here or get the complete documentation at https://docs.lucid-kv.store.

Works in Progress

You can take a look at the roadmap here, we are working on the implementation of persistence and encryption.

Command Line Interface

You can take a look at the Lucid command line on at https://asciinema.org/a/277538.

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

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 <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 @clintnetwork, @Slals, @CephalonRho, @rigwild and published under the MIT License.

Name / Nickname	Email	Role
Clint Mourlevat	me@clint.network	Lucid Founder
Jonathan Serra	jonathan@blocs.fr	Core Development
CephalonRho	CephalonRho@gmail.com	Core Development
Rigwild	me@rigwild.dev	Web UI Development

Contribute to Lucid

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