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. To learn more about CLAs, visit https://en.wikipedia.org/wiki/Contributor_License_Agreement.
Prerequisites
- Install clojure tools-deps
- macOS:
brew install clojure/tools/clojure
- Arch Linux:
pacman -S clojure
- macOS:
Building
make deps
- install all local dependenciesmake
ormake jar
- make Java .jar filemake nodejs
- make JavaScript Fluree DBmake browser
- make JavaScript WebWorker Fluree DBmake clean
- clean all build directories/filesmake install
- install jar file into local .m2/maven
Deploying
- Make sure you've setup everything in the Prerequisites section above.
- Install maven
- macOS:
brew install maven
- macOS:
- Set the version number in
pom.xml
- Run
make deploy