Public Preview - This version is in public preview and subject to changes. For production use, please use SDK v4.

​
Prerequisites

Following are the minimum requirements that must be met before attempting to install Ditto.
  • Java Development Kit (JDK) version 17
  • One of the following platforms and architectures:
    • Windows x86_64
    • Linux x86_64
    • MacOS arm64 (Apple Silicon) or x86_64

​
Get Started

​
1. Clone the Repository

  1. Open the terminal
  2. Clone the repository from GitHub.
    git clone https://github.com/getditto/quickstart
  3. Navigate to the project directory:
    cd quickstart

​
2. Configure Ditto

​
Get Ditto Database ID, Development Token, Auth URL, and Websocket URL

  1. Log in to your Ditto Portal account
  2. Navigate to your application and obtain the Ditto App ID, Playground Token, Auth URL, and Websocket URL. (see Getting SDK Connection Details for more details)

​
Add Ditto Credentials

  1. Copy the .env.sample file at the top level of the quickstart repo to .env and add your database ID and development token. 
    cp .env.sample .env
  2. Update the .env file with the Database ID and Development Token from your Ditto Application 
    DITTO_DATABASE_ID = "";
DITTO_DEVELOPMENT_TOKEN = "";
DITTO_AUTH_URL = "";
DITTO_WEBSOCKET_URL = "";

​
3. Run the Application

1

Open a terminal app and navigate to the quickstart/java-spring directory.
2

Run the following command to launch the web app: ./gradlew bootRun
3

Open http://localhost:8080 in a browser to interact with the app.

​
4. Sync-Data Offline

  1. Launch the application on multiple devices or simulators
  2. Disconnect from your current WiFi network while keeping WiFi enabled on the device to allow for LAN connections
  3. Add, edit, and delete tasks and experience offline collaboration!

​
Next Steps

All the Ditto Quickstart apps works together! Try running a quickstart app in other languages and see them all collaborate.

​
Additional Resources