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

Issue

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.

Solution

To create a Flutter package with an Example in Android Studio

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

flutter create example

enter image description here

  1. Select "Edit Configuration"-> add configuration -> Select the main.dart file that is located in the example/lib folder
    enter image description here
    enter image description here
    enter image description here
    enter image description here

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

    your_package_name:
    path: ..\
    enter image description here

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:
enter image description here

Answered By – Chris Sprague

Answer Checked By – Marilyn (FlutterFixes Volunteer)

Leave a Reply

Your email address will not be published. Required fields are marked *