Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evoluhq/evolu
A local-first platform designed for privacy, ease of use, and no vendor lock-in
https://github.com/evoluhq/evolu
crdt e2ee local-first offline-first react react-hooks react-native sqlite
Last synced: 1 day ago
JSON representation
A local-first platform designed for privacy, ease of use, and no vendor lock-in
- Host: GitHub
- URL: https://github.com/evoluhq/evolu
- Owner: evoluhq
- License: mit
- Created: 2022-09-25T10:35:42.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T14:41:53.000Z (about 2 months ago)
- Last Synced: 2024-10-29T15:06:16.873Z (about 1 month ago)
- Topics: crdt, e2ee, local-first, offline-first, react, react-hooks, react-native, sqlite
- Language: TypeScript
- Homepage: https://evolu.dev
- Size: 6.33 MB
- Stars: 1,416
- Watchers: 10
- Forks: 51
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- my-awesome-list - evolu - first platform designed for privacy, ease of use, and no vendor lock-in | evoluhq | 1490 | (TypeScript)
README
# 🚧 Important Announcement: Evolu Codebase is Being Rewritten
We are currently **rewriting the entire Evolu codebase** to implement a new synchronization protocol and **remove the dependency on Effect**. This rewrite aims to make Evolu more efficient, flexible, and easier to use while enabling powerful new features.
## What This Means:
- **New Sync Protocol**: Introducing a more robust and scalable approach to synchronization.
- **No Dependency on Effect**: Simplifying the core library by removing external dependencies.
- **Breaking Changes**: No breaking changes, API is the same, and everything is backward compatible. Evolu will migrate automatically; only internal tables have been changed.
## Timeline:
The rewrite has been completed, and the new sync is almost done. Expect experimental releases before the final stable version.
Thank you for your support and patience as we make Evolu better than ever! 💡
# Evolu
[Local-first](https://www.inkandswitch.com/local-first) platform designed for privacy, ease of use, and no vendor lock-in
- [SQLite](https://sqlite.org) in all browsers, Electron, and React Native
- [CRDT](https://crdt.tech) for merging changes without conflicts
- End-to-end encrypted sync and backup
- Free Evolu sync and backup server, or you can run your own
- Typed database schema (with branded types like `NonEmptyString1000`, `PositiveInt`, etc.)
- Typed SQL via [Kysely](https://kysely.dev)
- Reactive queries with full React Suspense support
- Real-time experience via revalidation on focus and network recovery
- No signup/login, only bitcoin-like mnemonic (12 words)
- Ad-hoc migration
- Sqlite JSON support with automatic stringifying and parsing
- Support for [Kysely Relations](https://kysely.dev/docs/recipes/relations) (loading nested objects and arrays in a single SQL query)
- Local-only tables (tables with \_ prefix are not synced)
- Evolu Solid/Vue/Svelte soon
## Local-first apps
Local-first apps allow users to own their data by storing them on their devices. Modern browsers provide API designed precisely for that. How is it different from keeping files on disk? Files are not the right abstraction for apps and cannot synchronize among devices. That's why traditional apps use the client-server architecture. But using client-server architecture also means that users' ability to use an app depends on some server that can be offline, temporarily or forever, if a company decides to ban a user or even goes bankrupt. That's unfortunate. Luckily, a way to restore data ownership exists. It's Evolu.
## Documentation
For detailed information and usage examples, please visit [evolu.dev](https://www.evolu.dev).
## API Reference
[evoluhq.github.io/evolu](https://evoluhq.github.io/evolu)
## Community
The Evolu community is on [GitHub Discussions](https://github.com/evoluhq/evolu/discussions), where you can ask questions and voice ideas.
To chat with other community members, you can join the [Evolu Discord](https://discord.gg/2J8yyyyxtZ).
[](https://x.com/evoluhq)
## Contributing
Evolu monorepo uses [pnpm](https://pnpm.io).
Install the dependencies with:
```
pnpm install
```
Build Evolu monorepo:
```
pnpm build
```
Start developing and watch for code changes:
```
pnpm dev
```
Start iOS developing (pnpm dev must be running too):
```
pnpm ios
```
Lint and tests:
```
pnpm lint test
```
Describe changes for release log:
```
pnpm changeset
```