Update: Starting from April 2018, this is no longer the latest branch or repository. Please go to https://github.com/ourconomy/openfxdb for the current development.

Open Fair DB with products/services

This experimental fork of Open Fair DB can handle products and services (called 'effects' in the code). It works as a backend for the ourconomy version of Karte von morgen which itself extends the scope to products and services.

From a technical point of view, everything that already existed for Entries has been implemented for Effects, too. The 'tags' table -- as an exception to this rule -- is there for both the entry_tag_relations and the effect_tag_relations.

The present version of Open Fair DB is work in progress. Todos:

• Clean up code and redundant comments
• Make effect result sorting and filtering work
• Implement ratings for effects
• Make tag deletion work
• ...

This is the description of the original project:

Open Fair DB

A micro backend for Karte von morgen written in Rust.

Build

Requirements:

• Rust (nightly)
• SQLite 3.x

Installing Rust & Cargo

If you're using Ubuntu 16.04 LTS you can run

sudo apt-get install curl libssl-dev gcc
curl https://sh.rustup.rs -sSf | sh
rustup install nightly
rustup default nightly

Installing SQLite & Diesel

On Ubuntu:

sudo apt-get install sqlite3 libsqlite3-dev
cargo install diesel_cli --no-default-features --features sqlite

Compile & Run

git clone https://github.com/flosse/openfairdb
cd openfairdb/
diesel migration run
cargo build
./target/debug/openfairdb

On NixOS you can build the project with:

nix-build -E '(import <nixpkgs>{}).callPackage ./default.nix {}'

REST API

The current REST API is quite basic and will change within the near future. The base URL is http://api.ofdb.io/v0/.

• GET /entries/:ID_1,:ID_2,...,:ID_n
• POST /entries
• PUT /entries/:ID
• GET /categories/
• GET /categories/:ID
• GET /search?text=TXT&bbox=LAT_min,LNG_min,LAT_max,LNG_max&categories=C_1,C_2,...,C_n
• GET /count/entries
• GET /count/tags
• GET /server/version
• POST /users
• POST /ratings
• GET /ratings

JSON structures

The structure of an entry looks like follows:

{
  "id"          : String,
  "version"     : Number,
  "created"     : Number,
  "name"        : String,
  "description" : String,
  "lat"         : Number,
  "lng"         : Number,
  "street"      : String,
  "zip"         : String,
  "city"        : String,
  "country"     : String,
  "email"       : String,
  "telephone"   : String,
  "homepage"    : String,
  "categories"  : [String],
  "tags"        : [String],
  "license"     : String
}

The structure of a category looks like follows:

{
  "id"      : String,
  "version" : Number,
  "created" : Number,
  "name"    : String,
  "parent"  : String
}

The structure of an rating looks like follows:

{
  "id"          : String,
  "created"     : Number,
  "title"       : String,
  "user"        : String,
  "value"       : Number,
  "context"     : String,
  "comments"    : Array,
}

Logging

RUST_LOG=debug ./target/debug/openfairdb

If you want to get stacktraces on panics use

export RUST_BACKTRACE=1

DB Backups

At the moment the OpenFairDB does not support online backups. Therefore we use a simple script that copies the DB file once a day.

License

Copyright (c) 2015 - 2017 Markus Kohlhase

This project is licensed under the AGPLv3 license.