relict

IMPORTANT NOTE: THIS SYSTEM IS NOT READY FOR PRODUCTION!

RelictDB

RelictDB is a balzing-fast in-memory database system built with Microsofts TypeScript, compiled to ES5 for maximal compatibility. The system is also modular that you can use it as a Database Client for API data serving or even extend it with other OpenSource adapters or simply write your own Adapter for it.

Contribute

General steps

1. Install Node.js for your OS from nodejs.org
2. Clone the Project to your computer via git clone [e-mail]:janbiasi/RelictDB.git
3. Install the dependencies in your working copy with your console entering npm install

Setup Visual Studio Code

1. Make sure you already done the General steps
2. Install MS Visual Studio Code (free) from http://code.visualstudio.com
3. Ctrl + Shift + P -> ext install TSLint -> Enter
4. Ctrl + Shift + P -> Tasks: Configure ... -> Gulp -> Enter

API

Database

Process

• Database > Sandbox > Serializer > Encryptor > Adapter
• Adapter > Decryptor > Deserializer > Sandbox > Database

Sandbox

Emitter

Adapters

• Filesystem (bundled)
• HTTP (bundled)
• tbd: add other recommendation

FileAdapter

HttpAdapter (in progress)

Encryption

• Plain (bundled)
• AES 256 CTR (bundled)
• tbd: add other recommendation

CtrEncryption

GcmEncryption (in progress)

PlainEncryption

Serializer

• JSON (bundled)
• tbd: add other recommendation

JSONSerializer