Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ditto.live/llms.txt

Use this file to discover all available pages before exploring further.

This content is for SDK V4. For the latest version, see the V5 documentation.

​
Prerequisites

Ditto’s JavaScript Console App Quickstart supports Windows, macOS and Linux. Before getting started, ensure you have the following:
  • A code editor (Visual Studio Code is our recommendation, but any code editor will work)
  • Git installed on your machine
  • Node.js installed on your machine
  • A Ditto Portal account with a configured Ditto Database (see Getting SDK Connection Details)

​
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 root directory: 
    cd quickstart

​
2. Configure Ditto

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

​
Add Ditto Credentials

  1. Copy the .env.sample file at the root of the quickstart repo to .env and add your app ID and online playground token. 
    cp .env.sample .env
  2. Update the .env file with the Database ID and Playground Token from your Ditto Database 
    DITTO_APP_ID="REPLACE_ME_WITH_YOUR_APP_ID"
DITTO_PLAYGROUND_TOKEN="REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN"
DITTO_AUTH_URL="REPLACE_ME_WITH_YOUR_AUTH_URL"
DITTO_WEBSOCKET_URL="REPLACE_ME_WITH_YOUR_WEBSOCKET_URL"

​
3. Run the Application

  1. Navigate to the project directory 
    cd javascript-tui
  2. Install dependencies 
    yarn install
  3. Run the Application 
    yarn dev

​
4. Sync-Data Offline

​
Next Steps

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

​
Additional Resources