rapiddb_web/
lib.rs

1#![doc(
2  html_logo_url = "https://raw.githubusercontent.com/kruserr/rapiddb/main/assets/logo/logo.svg",
3  html_favicon_url = "https://raw.githubusercontent.com/kruserr/rapiddb/main/assets/logo/favicon.ico"
4)]
5
6//! <p align="center">
7//!   <a href="https://github.com/kruserr/rapiddb" target="_blank">
8//!     <img width="300" src="https://raw.githubusercontent.com/kruserr/rapiddb/main/assets/logo/logo.svg">
9//!   </a>
10//!   <br/>
11//!   <br/>
12//!   <a href="https://crates.io/crates/rapiddb" target="_blank">
13//!     <img src="https://img.shields.io/crates/v/rapiddb?logo=Rust&logoColor=white"/>
14//!   </a>
15//!   <a href="https://hub.docker.com/r/kruserr/rapiddb" target="_blank">
16//!     <img src="https://img.shields.io/docker/v/kruserr/rapiddb?sort=semver&logo=docker&logoColor=white"/>
17//!   </a>
18//!   <a href="https://codecov.io/gh/kruserr/rapiddb" target="_blank">
19//!     <img src="https://img.shields.io/codecov/c/gh/kruserr/rapiddb?logo=Codecov&logoColor=white"/>
20//!   </a>
21//! </p>
22//!
23//! # RapidDB
24//! A reasonably fast configurable embedded key-value sensor database
25//!
26//! ## Features
27//! - Lightweight embedded database
28//! - Simple key-value database interface
29//! - Simple and flexible optional embedded REST API
30//! - Memory first with on-disk persistence
31//! - Memory Mapped Append-only Vector backing storage
32//! - Bring your own database or API implementation
33//! - Store sensor data inside a sensor database
34//!
35//! ## Getting Started
36//! ### Docker
37//! Run database with docker
38//! ```bash
39//! docker run -dit --rm -p 3030:3030 --name rapiddb kruserr/rapiddb:0.1
40//! ```
41//!
42//! [Further install options](docs/install.md)
43//!
44//! ### Use the database with curl
45//! Write to database with curl
46//! ```bash
47//! curl -X POST localhost:3030/api/v0/test-0 -d '{"temp":4.00}'
48//! ```
49//!
50//! Read from database with curl
51//! ```bash
52//! curl localhost:3030/api/v0/test-0/latest
53//! ```
54//!
55//! Explore the API with curl
56//! ```bash
57//! curl localhost:3030/api/v0
58//! curl localhost:3030/api/v0/sensors
59//! curl localhost:3030/api/v0/test-0
60//! ```
61//!
62//! ### Explore and customize the database
63//! The database is highly customizable, if you use the database inside
64//! your cargo project. You can interact with the `db` object, and
65//! explore the `IDatabase` interface. You can also use `warp::Filter`
66//! to extend the API. You can also implement the `IDatabase` interface
67//! yourself, for your own database. Explore the docs to learn more, or
68//! look at the examples.
69//!
70//! ## Documentation
71//! Visit the [Documentation](https://docs.rs/rapiddb-web).
72//!
73//! ## Examples
74//! Visit the [Examples](https://github.com/kruserr/rapiddb/tree/main/examples).
75
76pub mod api;
77pub use rapiddb;
rapiddb_web/lib.rs

rapiddb_web/
lib.rs
