Data engine with offline and realtime
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.babelrc
.gitignore
.npmignore
README.md
package.json

README.md

Amelisa

Data engine with offline and realtime

Join the chat at https://gitter.im/amelisa/amelisa

js-standard-style

Features

  • offline
  • realtime
  • data sync between devices
  • JSON CRDT type which includes operations on objects, arrays, strings, numbers and booleans
  • merging of complex data structures, like array of arrays of objects
  • collaborative text editing
  • isomorphic api
  • db-queries subscriptions with amelisa-mongo
  • GraphQL support (POC)
  • React and React Native integration with react-amelisa
  • horizontal scaling with amelisa-redis
  • Passport-based auth with amelisa-auth
  • access control
  • modular structure with plug-able storages, framework adapter, etc.

Warning

This software is in alpha stage. Does not follow semver till 1.0 version, breaking changes happen.

Inspired by

Installation

Amelisa requires NodeJS. You will also need to have a MongoDB and a Redis server running on your machine. The examples will connect via the default configurations.

$ npm install amelisa

Tests

$ npm test

Usage

Read documentation for more information.

MIT License

Copyright (c) 2015 by Vladimir Makhaev

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.