Schema-first Firestore tooling for types, validation, and visualization
Typesync is an open-source schema management tool for Firestore databases. You maintain a single source of truth for your Firestore architecture in a schema, then use the CLI to generate code and validate data from that schema.
Typesync helps keep your database, generated application code, and validation checks aligned as your schema changes.
- Generate Firestore models for TypeScript, Swift, and Python from one schema.
- Validate live Firestore documents with
typesync validate-data. - Generate Security Rules validators from the same model definitions.
- Visualize your Firestore architecture with Mermaid graphs.
- Carry schema documentation into generated model output.
View the full documentation (docs) ▸
Explore our comprehensive documentation for detailed guides, usage examples, and additional resources. It covers everything from the basics to more advanced topics:
- Introduction: Learn what Typesync is and its core features.
- Installation: Instructions on how to install the Typesync CLI.
- Quickstart: Get up and running with Typesync quickly.
- Upgrading: Guidelines on upgrading to the latest version of the CLI.
- Types: Details on the types supported by Typesync’s type system.
- validate-data: Validate Firestore documents against your schema.
This project is made available under the MIT License.