Overview • Getting Started • Features • Contributors • License •

Overview

An easy to set-up NodeJS server and mongoDB wrapper for clients to sync to when using turtleDB. Enables offline-first applications built with turtleDB to be fully collaborative with automated document versioning, history merging, and synchonization management.

Built using Express and Mongo DB Native NodeJS Driver.

Getting Started

Install

npm i tortoisedb

Usage

import TortoiseDB from 'tortoisedb';
// or
const TortoiseDB = require('tortoisedb');

// Create a new instance
const app = new TortoiseDB({
  // Choose database name  - defaults to 'default' if not provided
  name: 'demo',
  // Set server port - defaults to process.env.PORT if not provided
  port: 3000,
  // Provide mongodb URI - defaults to process.env.MONGODB_URI if not provided
  mongoURI: 'mongodb://localhost:27017',
  // Set batch limit - defaults to 1000 if not provided
  batchLimit: 1000
});

// Start up server
app.start();

// Drop database
app.dropDB();

Features

One-line simple setup
Automatic integration with mongoDB and turtleDB
Batching during synchronization

Contributors

Andrew Houston-Floyd - NYC - Website

Max Appleton - SF/Bay Area - Website

Steven Shen - Toronto - Website

License

This project is licensed under the MIT License.

turtle-DB / tortoiseDB

readme