shaunstoltz/db

Fluree database / query server source

Fluree DB

Usage documentation is located at https://docs.flur.ee.

Overview

Fluree is an immutable, temporal, ledger-backed semantic graph database that has a cloud-native architecture.

This repository is a stateless database as a library and designed to be utilized in conjunction with the Fluree Ledger which maintains all state. This database can be run in containers and dynamically scale to any desired load, can be embedded inside of your applications (Clojure, NodeJS for now) or can run as a stand-alone JVM service.

This database can also be built as a web-worker, and be embedded inside the browser. Thus far, a React Wrapper (Beta) has been developed that allows you to create real-time apps by wrapping your React components with queries (GraphQL or FlureeQL).

It is also possible to run Fluree in a "serverless" manner, where by utilizing Fluree SmartFunctions to embed data security along side your data (Data Defending Itself), you can have a permissioned application with just a single-page application (i.e. React) and Fluree Ledgers, but no application server.

Fluree includes time travel, allowing you to instantly query as of any historical moment in time, and even allows the abilty to stage proposed transactions to time travel into the future, to a hypothesized version of your data.

The best way to get started with Fluree is to go to the Getting Started page at https://flur.ee/getstarted/.

Development

Contributing

All contributors must complete a Contributor License Agreement.

Prerequisites

1. Install clojure tools-deps (version 1.10.3.933 or later).
   1. macOS: brew install clojure/tools/clojure
   2. Arch Linux: pacman -S clojure
2. Install Node & NPM
   1. macOS: brew install node
   2. Arch Linux: pacman -S nodejs

Building

• make deps - install all local dependencies

• make - make everything below

• make jar - make Java JAR file

• make nodejs - make JavaScript Fluree DB for Node

• make browser - make JavaScript Fluree DB for browsers

• make webworker - make JavaScript Fluree DB for web worker

• make install - install jar file into local .m2/maven

• make clean - clean all build directories/files

Tests

• make test - run all automated tests below
• make cljtest - run all CLJ tests
• make cljstest - run CLJS tests in headless Chrome & NodeJS
• make cljs-browser-test - run CLJS tests in headless Chrome
  • Needs karma-cli installed globally: npm install -g karma-cli
  • Needs Google Chrome browser installed
• make cljs-node-test - run CLJS tests in NodeJS