Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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: 5 days ago
JSON representation
High performance and distributed KV store w/ REST API. 🦀
- Host: GitHub
- URL: https://github.com/lucid-kv/lucid
- Owner: lucid-kv
- License: mit
- Created: 2019-07-27T19:49:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-31T23:36:25.000Z (almost 2 years ago)
- Last Synced: 2024-12-30T21:11:31.432Z (12 days ago)
- Topics: distributed-cache, docker, encryption, key-value, key-value-store, kv, persistence, rest-api, rust, sse
- Language: Rust
- Homepage: https://clintnetwork.gitbook.io/lucid/
- Size: 984 KB
- Stars: 379
- Watchers: 14
- Forks: 31
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-rust - Lucid - kv/lucid/workflows/Lucid/badge.svg?branch=master)](https://github.com/lucid-kv/lucid/actions?workflow=Lucid) (Applications / Database)
- awesome-rust-cn - Lucid
- awesome-rust - Lucid - High performance and distributed KV store accessible through a HTTP API. [](https://github.com/lucid-kv/lucid/actions?workflow=Lucid) (Applications / Database)
- awesome-rust-zh - lucid - 提供HTTP API的高性能KV数据库
- fucking-awesome-rust - Lucid - High performance and distributed KV store accessible through a HTTP API. [](https://github.com/lucid-kv/lucid/actions?workflow=Lucid) (Applications / Database)
- fucking-awesome-rust - Lucid - High performance and distributed KV store accessible through a HTTP API. [](https://github.com/lucid-kv/lucid/actions?workflow=Lucid) (Applications / Database)
README
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.