https://github.com/lucid-kv/documentation
Official Lucid Documentation, based on gitbook.
https://github.com/lucid-kv/documentation
distributed-key-value-database documentation gitbook key-value kv-store lucid
Last synced: 2 months ago
JSON representation
Official Lucid Documentation, based on gitbook.
- Host: GitHub
- URL: https://github.com/lucid-kv/documentation
- Owner: lucid-kv
- Created: 2019-10-19T15:08:24.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-03-23T15:57:09.000Z (over 5 years ago)
- Last Synced: 2025-07-07T03:10:18.828Z (3 months ago)
- Topics: distributed-key-value-database, documentation, gitbook, key-value, kv-store, lucid
- Homepage: https://docs.lucid-kv.store/
- Size: 128 KB
- Stars: 2
- Watchers: 6
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
Awesome Lists containing this project
README
---
description: "High performance and distributed KV store accessible through an HTTP API. \U0001F980"
---
# About Lucid ᵏᵛ
## Introduction
Lucid is currently in a development stage but we want to achieve a fast, secure and distributed key-value store accessible through an HTTP API, we also want to propose persistence, encryption, WebSocket streaming, replication and a lot of features.
**Some Uses Cases:** Private Keys Storing, IoT \(to collect and save statistics data\), Distributed Cache, Service Discovery, Distributed Configuration, Blob Storage etc.
### Getting Started
Get the latest binary from the [releases](https://github.com/lucid-kv/lucid/releases) page and run these commands:
```text
$ ./lucid init
$ ./lucid server
```
Or run a node with Docker, but you need to create a [lucid.yml](https://github.com/lucid-kv/lucid/blob/master/.github/lucid.yml) file locally before.
```text
$ docker pull lucidkv/lucid
$ docker run -v lucid.yml:/etc/lucid/lucid.yml lucidkv/lucid
```
{% page-ref page="getting-started.md" %}
## Some Use Cases
* Private Keys Storage \(for a wallet by example\)
* IoT: collect and save statistics data
* A distributed cache for an application
* Service Discovery
* Distributed Configuration
* Blob Storage
## About Development
Lucid is Written in Rust 🦀, initiated by [Clint.Network](https://twitter.com/clint_network) and published under the [MIT License](https://github.com/clintnetwork/lucid/blob/master/LICENSE.md).
| Name / Nickname | Email | Role |
| :--- | :--- | :--- |
| Clint Mourlevat | [me@clint.network](mailto:me@clint.network) | Core Development |
| Jonathan Serra | [jonathan@blocs.fr](mailto:jonathan@blocs.fr) | Core Development |
| CephalonRho | [CephalonRho@gmail.com](mailto:CephalonRho@gmail.com) | Core Development |
| Rigwild | [me@rigwild.dev](mailto:me@rigwild.dev) | Web UI Development |
### Contribute to Lucid
See [CONTRIBUTING.md](https://github.com/lucid-kv/lucid/blob/master/CONTRIBUTING.md) for best practices and instructions on setting up your development environment to work on Lucid.
{% embed url="https://github.com/lucid-kv" caption="" %}