drift/docs/pages/docs/Examples/index.md

3.1 KiB

data template
title weight description
Examples 3 Example apps using drift
layouts/docs/list

For a full example of a cross-platform Flutter app using drift following best practices, see app example in drift's repository. For interested users wanting to take a look at how to use drift in a Flutter app with a modern architecture, this is perhaps the best example to use as a starting point.

Drift's repository also contains a number of smaller examples showcasing select drift features:

  • The encryption example contains a simple Flutter app using an encrypted drift database, powered by the sqlcipher_flutter_libs package.
  • web_worker and flutter_web_worker are small web-only apps using drift in a shared web worker, which allows for a real-time synchronization of the database across tabs. Of course, this pattern can only be embedded into multi-platform apps.
  • The migration example makes use of advanced schema migrations and shows how to test migrations between different database schemas by using drift's [dedicated tooling][migration tooling] for this purpose.
  • [Another example][with_built_value] shows how to use drift-generated code in other builders (here, built_value).

Additional examples from our awesome community are available as well:

If you too have an open-source application using drift, feel free to reach out and have it added to this list!

If you are interested in seeing more drift examples, or want to contribute more examples yourself, don't hesitate to open an issue either. Providing more up-to-date examples would be a much appreciated contribution!

Additional patterns are also shown and explained on this website:

[migration tooling]: {{ '../Advanced Features/migrations.md#verifying-migrations' | pageUrl }} [with_built_value]: https://github.com/simolus3/drift/tree/develop/examples/with_built_value