-
Notifications
You must be signed in to change notification settings - Fork 0
Public/preparation #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,89 @@ | ||
| # SQLoot | ||
| <div align="center"> | ||
| <img src="../branding/sqloot-banner.svg" alt="SQLoot banner" width="900" /> | ||
| </div> | ||
|
|
||
| <p align="center"> | ||
| <strong>Local-First | Lab | E2EE | Infra | Benchmarks | Tools | CLI | Adapters | CRDT Sync | Relays</strong><br /> | ||
| Public rollout is in progress (updated March 1, 2026). | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <img src="https://img.shields.io/badge/Public_rollout-WIP-f59e0b?style=flat-square" alt="Public rollout WIP" /> | ||
| <img src="https://img.shields.io/badge/Built_on-Evolu-1f6feb?style=flat-square" alt="Foundation Evolu" /> | ||
| <img src="https://img.shields.io/badge/Compatibility-SQLite-0ea5e9?style=flat-square" alt="SQLite compatibility" /> | ||
| <img src="https://img.shields.io/badge/Bun-v1.3.10-111827?style=flat-square&logo=bun&logoColor=white" alt="Bun-first runtime" /> | ||
| </p> | ||
|
|
||
| ## ⚡ Why SQLoot | ||
|
|
||
| - 🌍 Grow the local-first community and make the ecosystem easier to discover and adopt. | ||
| - 🛠️ Build practical tools and a robust CLI for developers and operators. | ||
| - ⚡ Push performance in critical paths with Zig/Rust and systems-level optimizations. | ||
| - 🧩 Keep Evolu compatibility while delivering upgrades and upstream-ready improvements. | ||
| - 🧪 Run experiments, publish benchmarks, and propose new local-first specs where needed. | ||
| - 🤖 Advance local-first collaboration patterns for AI agents. | ||
|
|
||
| ## 🤝 Foundation: Evolu | ||
|
|
||
| SQLoot currently runs on top of an Evolu-based baseline. Our immediate strategy is to preserve upstream compatibility, ship measurable improvements in our fork, and upstream changes where applicable. | ||
|
|
||
| - Upstream project: [evoluhq/evolu](https://github.com/evoluhq/evolu) | ||
| - Upstream docs: [evolu.dev](https://www.evolu.dev) | ||
| - SQLoot baseline fork: [SQLoot/evolu-plan-b](https://github.com/SQLoot/evolu-plan-b) | ||
|
|
||
| Credit where it belongs: huge respect to [evoluhq](https://github.com/evoluhq) and [@steida](https://github.com/steida) for creating Evolu and moving the local-first ecosystem forward. | ||
|
|
||
| ## 🧱 What SQLoot Is Building | ||
|
|
||
| | Track | Role | Current State | | ||
| |---|---|---| | ||
| | `evolu-plan-b` | Evolu-compatible Bun + Biome baseline | Public rollout | | ||
| | `core` | SQLoot-native runtime foundations (Rust/Zig) | Planning | | ||
| | `bench-suite` | Reproducible benchmark harness | WIP | | ||
| | `relays` | Evolu-compatible relay implementations (Bun+Elysia/Rust/BEAM) | WIP | | ||
| | `lootbox` | CLI umbrella, TUI, tools (Rust) | WIP | | ||
| | `blind-cloud` | Encrypted cloud transport experiments (vault/relay/repacker) | Research | | ||
| | `local-first` | Community forum, blog, wiki, guides | TBD | | ||
| | `loot-cms` | File-based CMS, editor, sync storage | Research | | ||
| | `loot-ops` | Org-wide platform glue for repos (Nix/IaC/CI) | Private | | ||
| | `website` | Landing page, docs, bench measurements, stats | WIP | | ||
| | `knowledge` | Obsidian KB, planning, issues, research | Internal | | ||
|
|
||
| Public docs and public APIs are opening in phases as each track stabilizes. | ||
|
|
||
| ## 🗺️ 2026 Roadmap (WIP) | ||
|
|
||
| ### Milestone Progress (as of March 1, 2026) | ||
|
|
||
| - [x] 📦 Public track for `evolu-plan-b` prepared (100%) | ||
| - [x] 🧩 Evolu-based Bun-first baseline established (95%) | ||
| - [ ] 🔌 Priority integrations (TanStack Start, Tauri, Astro) (75%) | ||
| - [ ] 🧪 Benchmark harness foundation in `bench-suite` (45%) | ||
| - [ ] 📊 Regression evidence gates (p50/p95/throughput/memory) (40%) | ||
| - [ ] 🌐 Relay and transport hardening (`relays`, `blind-cloud`) (30%) | ||
| - [ ] 🧱 SQLoot core bootstrap (`core`) (20%) | ||
| - [ ] 🛠️ `lootbox` CLI baseline (scope, commands, packaging) (25%) | ||
| - [ ] 📚 Public docs and evidence surfaces (`website`, `local-first`) (35%) | ||
|
|
||
| Open-source infrastructure for intelligent data management. | ||
| ## 🎯 Next 4 Weeks | ||
|
|
||
| > 🚧 **Coming Soon** - Repositories are currently private during development. | ||
| 1. Lock `evolu-plan-b` public baseline: keep CI green, tighten docs, and close rollout gaps. | ||
| 2. Ship `bench-suite` baseline lanes with reproducible report schema and first regression thresholds. | ||
| 3. Stabilize integration lanes for TanStack Start, Tauri, and Astro with actionable smoke outputs. | ||
| 4. Define and run relay hardening matrix for reconnect/load/failure handling in `relays`. | ||
| 5. Ship `lootbox` CLI v0 scope and first operator commands for workspace/bootstrap + benchmark flows. | ||
|
|
||
| ## Contributing | ||
| ## 🤝 Contributing | ||
|
|
||
| We welcome contributions! See [CONTRIBUTING](https://github.com/SQLoot/.github/blob/main/CONTRIBUTING.md) for guidelines. | ||
| Contributions are welcome. See [CONTRIBUTING](https://github.com/SQLoot/.github/blob/main/CONTRIBUTING.md) for workflow and quality standards. | ||
|
|
||
| ## Security | ||
| ## 🔐 Security | ||
|
|
||
| Found a vulnerability? See [SECURITY](https://github.com/SQLoot/.github/blob/main/SECURITY.md) for responsible disclosure. | ||
| For responsible disclosure, see [SECURITY](https://github.com/SQLoot/.github/blob/main/SECURITY.md). | ||
|
|
||
| --- | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/enterprises/ownCTRL"><img src="https://img.shields.io/badge/©️_2026-ownCTRL™-333?style=flat&labelColor=ddd" alt="© 2026 ownCTRL™"/></a> | ||
| <a href="https://github.com/ownctrl"><img src="https://img.shields.io/badge/⚙️_Maintained_with_🩶_by-%40ownctrl-333?style=flat&labelColor=ddd" alt="Maintained by @ownctrl"/></a> | ||
| <a href="https://github.com/miccy"><img src="https://img.shields.io/badge/⚙️_Maintained_with_🩶_by-%40miccy-333?style=flat&labelColor=ddd" alt="Maintained by @miccy"/></a> | ||
| </div> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.