Skip to main content

Prerequisites

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

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, and Server URL

In the Ditto Portal, open your database and get its Database ID and Development Token. Copy the URL shown under “Connect via SDK” for DITTO_SERVER_URL. See Getting SDK Connection Details for details.

Add Ditto Credentials

  1. From the quickstart repository root, copy .env.sample to .env and add your database ID, development token, and server URL.
  2. Set these values in .env using the connection details for your Ditto Database:

3. Run the Application

  1. Open a terminal app and navigate to the java-server directory.
  2. Run the following command to launch the web app:
  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 work together! Try running a quickstart app in other languages and see them all collaborate.

Additional Resources