Awesome
<p align="center"> <p align="center"> <img src="https://github.com/lucid-kv/deploy-templates/blob/master/lucid.png?raw=true" height="100" alt="Lucid KV" /> </p> <h3 align="center"> About Lucid KV </h3> <p align="center"> High performance and distributed KV store w/ REST API. 🦀 </p> <p align="center"> <a href="https://github.com/lucid-kv/lucid/actions?workflow=Lucid"><img src="https://github.com/lucid-kv/lucid/workflows/Lucid/badge.svg" /></a> <a href="https://www.rust-lang.org/"><img src="https://img.shields.io/badge/Made%20With-Rust-dea584" /></a> <a href="https://github.com/lucid-kv/lucid/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/license-MIT-lightgrey.svg" /></a> <a href="https://discord.gg/mZz67M6"><img src="https://img.shields.io/badge/Discord-Server-7289DA" /></a> </p> </p>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 →
Getting Started
Get the latest binary from the 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 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 https://lucid-kv.herokuapp.com/ or deploy your own:
<a href="https://heroku.com/deploy?template=https://github.com/lucid-kv/lucid" target="_blank"><img src="https://www.herokucdn.com/deploy/button.svg" height="32"/></a> <a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Flucid-kv%2Flucid%2Fmaster%2F.github%2Fazure%2Fazuredeploy.json" target="_blank"><img src="https://aka.ms/deploytoazurebutton" height="32"/></a>
Documentation
You can quickly start here or get the complete documentation at https://clintnetwork.gitbook.io/lucid/.
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 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 @thisisclint21, @Slals, @CephalonRho, @rigwild and published under the MIT License.
| Name / Nickname | 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 for best practices and instructions on setting up your development environment to work on Lucid.