Install Guides

Node.js

To get started right away without having to build an app from scratch, explore with the Ditto ready-to-use demo task app.

Prerequisites

Before you can install Ditto, you must have the following:

  • Ditto access credentials
  • Node.js active long-term support (LTS) version 18.x or 20.x
  • Linux, macOS version 11 (or later), or Windows version 10 (or later)
  • Git
  • Integrated developer environment (IDE)

Installing the Demo Task App

To install Ditto in your environment, install and set up Ditto, and authenticate your client identity with the Big Peer:

1

Clone the getditto > template-app-nodejs-todo repository from GitHub:

Bash

2

Install the required dependencies:

Bash

3

Open the project in your IDE, and then open the index.ts file. For example, if using Visual Studio Code:

Bash

4

In line 14 of the index.ts file, replace 'YOUR_APP_ID' and 'YOUR_TOKEN' with your app ID and playground token. (See Getting Playground Token Credentials)

TypeScript

5

Build the demo task app:

Bash

6

Interact with the demo task app and simulate real-time peer-to-peer replication by running the demo task app in two or more separate terminals (one for each virtual peer):

Bash

7

Using the commands that automatically appear in each of your terminals, add, remove, and modify documents as desired.

8

If you want to observe your changes sync with the cloud-optional deployment, the Big Peer, open the data browser in the Ditto portal.



Updated 28 Aug 2024
Did this page help you?