https://github.com/kafkas/typesync

Single source of truth for Firestore
https://github.com/kafkas/typesync

cli cloud-firestore firestore nodejs python schema-management security-rules swift typescript validation

Last synced: 23 days ago
JSON representation

Single source of truth for Firestore

• Host: GitHub
• URL: https://github.com/kafkas/typesync
• Owner: kafkas
• License: agpl-3.0
• Created: 2024-03-02T19:31:20.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2026-04-26T16:15:00.000Z (about 1 month ago)
• Last Synced: 2026-04-26T16:25:30.746Z (about 1 month ago)
• Topics: cli, cloud-firestore, firestore, nodejs, python, schema-management, security-rules, swift, typescript, validation
• Language: TypeScript
• Homepage: https://docs.typesync.org
• Size: 1.31 MB
• Stars: 55
• Watchers: 1
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


  





  typesync





    Schema-first Firestore tooling for types, validation, and visualization





    

        

    

        

    

      

    

        

    

      



Typesync is an open-source schema management tool for [Firestore](https://cloud.google.com/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.

# How Typesync Helps You

- 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) ▸**](https://docs.typesync.org)



  



# Documentation

Explore our comprehensive [documentation](https://docs.typesync.org) for detailed guides, usage examples, and additional resources. It covers everything from the basics to more advanced topics:

- [Introduction](https://docs.typesync.org/introduction): Learn what Typesync is and its core features.

- [Installation](https://docs.typesync.org/installation): Instructions on how to install the Typesync CLI.

- [Quickstart](https://docs.typesync.org/quickstart): Get up and running with Typesync quickly.

- [Upgrading](https://docs.typesync.org/upgrading): Guidelines on upgrading to the latest version of the CLI.

- [Types](https://docs.typesync.org/schema/types): Details on the types supported by Typesync’s type system.

- [validate-data](https://docs.typesync.org/cli/validate-data): Validate Firestore documents against your schema.

# License

This project is made available under the MIT License.