# Sp00ky Sync

> A reactive, local-first sync framework for SurrealDB.

Sp00ky Sync lets you build offline-ready, real-time applications using SurrealDB as both local and remote database. It handles bidirectional sync, conflict resolution, authentication, schema migrations, and file storage — so you can focus on your product.

## Documentation

### Getting Started

- [Introduction](https://mono424.github.io/sp00ky/docs)
- [Installation](https://mono424.github.io/sp00ky/docs/install)
- [Schema](https://mono424.github.io/sp00ky/docs/schema)
- [Migrations](https://mono424.github.io/sp00ky/docs/migrations)
- [Authentication](https://mono424.github.io/sp00ky/docs/authentication)
- [Query Data](https://mono424.github.io/sp00ky/docs/query-data)
- [Mutate Data](https://mono424.github.io/sp00ky/docs/mutate-data)
- [Backend Functions](https://mono424.github.io/sp00ky/docs/backend-functions)
- [File Buckets](https://mono424.github.io/sp00ky/docs/buckets)

### Framework Guides

- [SolidJS](https://mono424.github.io/sp00ky/docs/guide/solid)
- [Flutter](https://mono424.github.io/sp00ky/docs/guide/flutter)
- [Vanilla JS / TS](https://mono424.github.io/sp00ky/docs/guide/vanilla)

### Reference

- [Configuration](https://mono424.github.io/sp00ky/docs/configuration)
- [Deployment](https://mono424.github.io/sp00ky/docs/deployment)
- [Architecture](https://mono424.github.io/sp00ky/docs/architecture)
- [Scheduler API](https://mono424.github.io/sp00ky/docs/scheduler-api)
- [SSP API](https://mono424.github.io/sp00ky/docs/ssp-api)

## Source Code

- [GitHub Repository](https://github.com/mono424/sp00ky)