https://github.com/entitydb/entitydb

leveldb entity system
https://github.com/entitydb/entitydb

Last synced: 5 days ago
JSON representation

leveldb entity system

• Host: GitHub
• URL: https://github.com/entitydb/entitydb
• Owner: entitydb
• Created: 2014-05-12T21:40:25.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-05-14T22:48:53.000Z (over 10 years ago)
• Last Synced: 2024-08-01T12:35:34.358Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 188 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - entitydb/entitydb - leveldb entity system (others)

README

        
# entitydb

[![server tests](https://travis-ci.org/entitydb/entitydb.png)](https://travis-ci.org/entitydb/entitydb)

[![npm version](https://badge.fury.io/js/entitydb.png)](https://npmjs.org/package/entitydb)

[![dependency status](https://david-dm.org/entitydb/entitydb.png)](https://david-dm.org/entitydb/entitydb)

[![devDependency status](https://david-dm.org/entitydb/entitydb/dev-status.png)](https://david-dm.org/entitydb/entitydb#info=devDependencies)

[![browser tests](https://ci.testling.com/entitydb/entitydb.png)](https://ci.testling.com/entitydb/entitydb)

leveldb entity system

#### work in progress

## projected features

- [composed of modules](https://github.com/entitydb)

- uses [level-sublevel](https://github.com/dominictarr/level-sublevel) to separate and nest entity databases

- uses [levelgraph-jsonld](https://github.com/mcollina/levelgraph-jsonld) to store entity relationships in a searchable graph

- works on the server or in the browser, see [levelgraph-jsonld#3](http://github.com/mcollina/levelgraph-jsonld/issues/3)

- able to reflect entities over various interfaces similar to [resources](https://github.com/ahdinosaur/resources)

  - REST api with auto docs

  - [multilevel](https://github.com/juliangruber/multilevel)

  - IRC

  - README docs

- all entity methods emit events

- all entity methods have pre / post hooks

## how to use

```bash

npm install --save entitydb

```

```javascript

var level = require('level');

var db = level('./db');

var e = require('entitydb');

var Account = e.Graph.extend({

  name: "accounts",

  schema: {

    type: e.Types.String,

    context: "foaf:accountName",

  },

});

var Agent = e.Graph.extend({

  name: "agents",

  schema: {

    type: e.Types.Object,

    properties: {

      name: {

        type: e.Types.String,

        context: "foaf:name",

        required: true,

      },

    },

  },

  config: {

    base: "https://agents.open.app",

  }

});

var Person = AgentDB.extend({

  name: "persons",

  schema: {

    properties: {

      account: {

        type: Account,

      },

    },

  ),

  config: {

    base: "https://persons.open.app",

  },

});

var personDB = new Person(db);

personDB.put({

  "name": "Mikey",

}, function (err, me) {

  me.account = [{

    "@id": "loomio",

    "accountName": "ahdinosaur"

  }, {

    "@id": "cobudget",

    "accountName": "dinosaur"

  }]

  personDB.put(me);

});

```

## how to develop

```

git clone https://github.com/entitydb/entitydb

npm install

```

hack away!

```

npm test

```

- to run testling locally, you need to install [`xvfb`](http://packages.debian.org/stable/xvfb)

  - `[sudo] apt-get install xvfb`

## license

AGPLv3