How do I add an Example Project to a Flutter Package?

Question

Is there a way to autogenerate template code for the example map structure in a package?

Most packages have a /example folder within the package root that showcases the package functionality. I'm not sure what's the "best" way to create the example is, or if it even matter.

Do I create all files individually? Do I create a new project and then copy it to the package root? Can I autogenerate an example project directly in the project?

It's my first attempt on creating a package and I want to get it right the first time.

Answer 1

To create a Flutter package with an Example in Android Studio

1. Create a new Flutter Project
2. Select Flutter Package
3. After the new project opens in Android Studio, select the "Terminal" tab and then run:

flutter create example

4. Select "Edit Configuration"-> add configuration -> Select the main.dart file that is located in the example/lib folder

5. Open your example pubspec.yaml and link to the library by adding:

   your_package_name: path: ..\

NOTE: When you open the Example folder it will look like an entire Flutter app nested into your project; that's because it is. Just open the io and android folders to see that they share that pattern:

Answer 2

Create a new project inside the root directory of your project called example and then remove unnecessary files such as CHANGELOG, LICENSE and README as they will be in your package folder.

Here's an example (no pun intended) with a package that I created:

Now in pubspec.yaml you should include your package as dev dependency like this:

dev_dependencies:   your_package:     path: ../ 

I believe you can also use regular dependencies, but this worked for me.

Now inside /lib you can add a main.dart file, import your package and then create an example project.