This project is early in development and not yet ready for general use.
Expect bugs, missing docs, incomplete features etc!
Full-stack tooling for building local-first web apps with a focus on simplicity, interoperability and longevity.
Use Cases | Quick Start | Documentation | Examples | Encryption Spec | Roadmap-
Simplicity
Software should be simple. Localful doesn't use CRDTs or an advanced distributed database, it accepts the tradeoffs and limitations of a simpler system to store and syncronise data using immutable versions which are created when data is changed. This allows you to easily understand what's going on and how, so you can spend less time thinking and more time making.
-
Interoperability
Your data is yours and should be avaliable without vendor or technology lock-in. Keeping things simple means less reliance on any specific library, langauge or implementation. The web library uses standard IndexDB and the server uses Postgres and a well documented HTTP and Websockets (socket.io) API. The current focus of Localful is on web applications, however the server could be used by anything that speaks HTTP and Websockets.
-
Longevity
If you don't need to manage lots of complexity and build software with interoperability in mind, then you can be confident that your applications will be easier to manage in the long term and your data will continue to be accesible. If you do decide to migrate in the future, you have everything stored in IndexDB and Postgres ready and waiting.
- Local-first storage using IndexDB.
- Client-side encryption, including locally in IndexDB.
- Schema definitions using Zod.
- Migration support for schemas and data.
- Basic local queries with support with filtering, ordering, grouping etc.
- Built-in reactivity for local data fetching via RxJS Observables.
- Self-hostable Node.js server for account creation, data storage and cross-device synchronisation.
Feel free to suggest features, give feedback, suggest improvements, raise bugs, open PRs and anything else.
This project is released under the GNU AGPLv3 license.