# koredb

> The Simplest Distributed Log Database

Latest version **0.5.0** (published 2019-06-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install koredb
pnpm add koredb
yarn add koredb
bun add koredb
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2019-06-01 |
| First published | 2019-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 348.5 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | charles.lobo@gmail.com |
| Maintainers | tpp |

## Links

- npm: https://www.npmjs.com/package/koredb
- Repository: https://github.com/theproductiveprogrammer/kore
- Homepage: https://github.com/theproductiveprogrammer/kore#readme
- Issues: https://github.com/theproductiveprogrammer/kore/issues
- npm.io page: https://npm.io/package/koredb

## Dependencies (1)

- [uuid](https://npm.io/package/uuid.md) ^3.3.2

## Recent versions

- 0.5.0 (latest) — 2019-06-01
- 0.4.0 — 2019-04-23
- 0.3.0 — 2019-01-03
- 0.2.0 — 2019-01-03

## README

Kore - The Embedded Distributed Log Datastore
=============================================

Looking for a simple embedded
database to store and manage your
data across multiple devices?
**Kore** is the solution you need.

First we had
[Lambda](https://en.wikipedia.org/wiki/Lambda_architecture).
Then we had [Kappa](http://milinda.pathirage.org/kappa-architecture.com/)...

Now we have **KORE**!

![kore.png](kore.png)


**Kore** - The Embedded Distributed Log Datastore

## Is Kore for me?

**Kore** is ideal for you if you
have an app with users on multiple
devices (say phone, pad, and
desktop) and need a simple storage
solution without needing to learn
a query language or do any complicated
object-relational mappings.

**Kore** is embedded so deployment is
much simpler - no need to install
and manage a separate database
server.

**Kore** handles disconnections
(on your commute - or on your yatch!)
automatically. It will synchronize
with any upstream nodes correctly,
handling all the complicated edge
cases of managing distributed
data. Users never need to worry
about not being able to "reach
the server".

**Kore** allows you to quickly
and easily set up your initial data,
improve your handling of it
iteratively, and handle cross device
synchronization with near-realtime
updates.

## Is Kore NOT for me?

**Kore** is not for you if you need
a database with a heavy load
(thousands of requests a minute), or
you need the database to do a lot of
processing/complex queries.

Otherwise **Kore** is an excellent
option you could keep in your
toolbox. It's the 'lighter sqllite'
you have been looking for  :-D

*  [Learn More](docs/INTRO.md)
*  [Architecture](docs/ARCH.md)
*  [Getting Started](docs/START.md)
*  [Concepts](docs/CONCEPTS.md)


# How to Contribute to Kore
**Kore** is open to everyone and any
help is greatly appreciated.  Feel
free to
[raise issues](https://github.com/theproductiveprogrammer/kore/issues),
[contribute features](https://github.com/theproductiveprogrammer/kore/pulls),
[improve the documentation](https://github.com/theproductiveprogrammer/kore/pulls),
or simply
[add your suggestions](https://github.com/theproductiveprogrammer/kore/issues).


# Pending Features

* Migration Support
* Support for other languages
  (Python, Java, ...)

---
_Source: https://npm.io/package/koredb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
