Skip to content

EntglDb/EntglDb.Spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

EntglDb Central Hub 🕸️

The Mesh Database for Local-First Applications.

Note: This repository contains the Official Specifications and the Documentation Website for EntglDb. For implementation code, please visit the specific language repositories.

📚 Repository Structure

  • spec/: Canonical Specifications. The source of truth for the EntglDb protocol, including Discovery (UDP), Transport (Noise/TCP), and Synchronization logic.
  • website/: Documentation Site. The source code for entgldb.com (or your domain), built with Vue 3 and Vite.

🌍 Ecosystem

Language Repository Status
C# / .NET EntglDb.Net ✅ Stable (v0.6+)
Kotlin EntglDb.Kotlin ⚠ Alpha (v0.2+)
Node.js EntglDb.NodeJs 🚧 In Development

🚀 Getting Started with the Specs

If you are building an EntglDb implementation or want to understand the internals:

  1. Start with Discovery.
  2. Read the Wire Protocol definitions.
  3. Understand the Data Model.
  4. Study the Synchronization algorithms.

🛠️ Building the Website

The documentation site is a static SPA.

cd website
npm install
npm run dev

🤝 Contributing

We welcome contributions to the specifications! If you find an ambiguity or an error in the protocol definition, please open an Issue or a Pull Request. See CONTRIBUTING.md for details.

📄 License

MIT © 2026 EntglDb Project.

About

EnglDb Specifications

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors