Skip to content

Commit 654d8fb

Browse files
committed
feat(examples): add comprehensive SQLite Sync examples README
1 parent 0f7a5e7 commit 654d8fb

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

examples/README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# SQLite Sync Examples
2+
3+
This directory contains comprehensive examples demonstrating SQLite Sync in various environments and use cases. Each example showcases offline-first data synchronization across multiple devices using SQLite AI's sync capabilities.
4+
5+
## Examples Overview
6+
7+
### [simple-todo-db/](./simple-todo-db/)
8+
**Basic CLI Example - Getting Started**
9+
- Command-line demonstration using SQLite CLI
10+
- Shows fundamental SQLite Sync concepts and workflow
11+
- Multi-device collaborative editing with conflict resolution
12+
- Offline scenarios and network synchronization
13+
- Perfect for understanding core sync mechanics
14+
15+
### [sport-tracker-app/](./sport-tracker-app/)
16+
**Advanced Web App - Production Patterns**
17+
- React/TypeScript web application with Vite
18+
- Demonstrates secure authentication with Access Tokens
19+
- Row-Level Security (RLS) implementation for data isolation
20+
- Multi-user scenarios (athletes and coaches)
21+
- WASM SQLite with sync extension
22+
- Production-ready security patterns
23+
24+
### [swift-multiplatform-app/](./swift-multiplatform-app/)
25+
**Swift iOS/macOS Integration**
26+
- Cross-platform Swift app for iOS and macOS
27+
- CloudSync XCFramework integration guide
28+
- Native mobile and desktop sync capabilities
29+
- Xcode project setup and security configuration
30+
31+
### [to-do-app/](./to-do-app/)
32+
**React Native/Expo Mobile App**
33+
- Cross-platform mobile app (iOS/Android)
34+
- Expo framework with SQLite sync
35+
- Simple task management with categories
36+
- Offline-first mobile development patterns
37+
- **Note**: Uses basic connection strings for demo purposes only
38+
39+
## Getting Started
40+
41+
1. **Begin with**: `simple-todo-db/` for core concepts
42+
2. **Production web apps**: Use `sport-tracker-app/` patterns
43+
3. **Native mobile**: Choose `swift-multiplatform-app/` or `to-do-app/`
44+
45+
Each example includes detailed setup instructions, code explanations, and security considerations. See the individual README files for specific implementation details.
46+
47+
---
48+
49+
**Note**: For generic extension loading guides please refer to the [SQLite Extension Guide](https://github.com/sqliteai/sqlite-extensions-guide) repository

0 commit comments

Comments
 (0)