https://github.com/getditto/template-rust
A sample app showing how to sync offline with Ditto using Rust
https://github.com/getditto/template-rust
Last synced: 3 months ago
JSON representation
A sample app showing how to sync offline with Ditto using Rust
- Host: GitHub
- URL: https://github.com/getditto/template-rust
- Owner: getditto
- Archived: true
- Created: 2024-06-03T14:19:05.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-13T18:28:58.000Z (about 2 years ago)
- Last Synced: 2026-04-04T01:44:32.688Z (3 months ago)
- Language: Rust
- Size: 129 KB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `template-rust`
This is a template starter project for showing how to develop
applications using Ditto's Rust SDK.
## About Ditto
[Ditto is an "edge-sync platform"][0], which allows your apps to
work and communicate even while offline. The Ditto SDKs allow
you to read and write changes to a local database even while
offline, but will automatically connect to nearby peers and sync
changes with each other.
- [Ditto Rust API Docs][1]
## Getting Started
To get started with Ditto, [visit the Ditto Portal and create an App][2],
then find your "App ID" and Playground Token. You'll use these to
authenticate your SDK instances so they can securely sync with each other.
> The AppID and token in this screenshot are fake, you need to create
> your own Ditto account and App, then copy the AppID and Playground Token
> generated for you :)
Next, copy the `.env.sample` file and rename it to `.env` to use it:
```
cp .env.sample .env
```
Edit the `.env` file and paste your App ID and Playground Token:
```
#!/usr/bin/env bash
# ...
export APP_ID="" # Your App ID
export PLAYGROUND_TOKEN="" # Your Playground Token
```
Now you can build and run the available sample apps. Be sure to check the
`--help` menu to see subcommands and options for each app.
### Simple Querybuilder
This sample shows how to use Ditto's "Query Builder" API to
create and subscribe to documents:
```
cargo run --bin=simple_querybuilder -- --collection="cars"
# ...
Inserted document with id=6659efed00288113001bb5a9
```
### Simple DQL
This sample shows how to use Ditto's new "Ditto Query Lanuage" (or DQL)
to insert and query for documents:
```
cargo run --bin=simple_dql -- insert-car --make="ford" --color="blue"
cargo run --bin=simple_dql -- select-cars --color="blue"
```
### Simple Attachments
This sample shows how to upload and download large files using Ditto's
Attachments API:
```
cargo run --bin=simple_attachments -- upload-photo --path=$HOME/Downloads/photo.png
cargo run --bin=simple_attachments -- download-photo --name=photo.png
```
[0]: https://ditto.live
[1]: https://docs.rs/dittolive-ditto
[2]: https://portal.ditto.live