How do I create and share a minimal example project?

When our support team asks for a minimal example project, we mean a small project that shows only the problem and nothing else. When you send one, we can run it on our side, see the same result you see, and find the cause much faster. This is the quickest way to get a bug fixed.

First, check our demo: Before you build an example, try to make the problem happen in our live demo. If it happens there, that points to the SDK, and we can move faster. If it does not happen, the problem is likely in your own setup, and the example project below is what we need.

What is a minimal example project?

A good example project has three things:

• Small. It has only the code needed to show the problem. Everything else is removed.
• Complete. It has everything needed to run it. We should not have to add missing files or guess your setup.
• Reproducible. It shows the problem every time it runs, and you have checked that it does.

How to build it?

1. Start from a small base. Create a fresh, small project, or take one of our example projects and add only the part that breaks. You can find them on our GitHub.
2. Add only the code that shows the problem. Remove screens, styling, and anything that is not part of the issue.
3. Add a sample file if the problem needs one. If it happens with a certain image, video, or font, include a small sample you are allowed to share. Do not use private or copyrighted files.
4. Include your setup. Add the SDK setup and the config options you use, because the cause is often one specific setting.
5. Check that it reproduces. Run the project and confirm the problem shows up, then write down the exact steps that trigger it.
6. Note what you expected and what happened. Please share the result you wanted, and what you got instead.

How to share it?

The best way to share depends on your platform.

• Web: send a StackBlitz link. It runs your project in the browser, which lets us open it and see the same result right away.
• iOS, Android, React Native, and Flutter: send the project itself. Attach a zip file to your ticket, send a download link, or share a public GitHub repo.

Make the project public or the link open. This lets us access it without extra steps.

When you write us, also add:

• Your SDK and version. If it broke after an update, tell us the version you came from.
• Your platform and version, like iOS 18 or Flutter 3.x.
• Whether the problem also happens in our demo.
• The steps to reproduce, and what you expected versus what happened.