heyinsight_package 1.0.0 copy "heyinsight_package: ^1.0.0" to clipboard
heyinsight_package: ^1.0.0 copied to clipboard

This is package for heyinsight with notification features. @HeySheep

Flutter HeyInsight #

This repository is a mini-tutorial to help you create the sample app for your tutorial on kodeco.com. The repository here includes the resources you'll need to make your app look good wherever your readers build the app.

Sample project requirements #

All projects for kodeco.com Flutter tutorials should include the following items:

  • com.kodeco base package name (Android, iOS)
  • Kodeco license
  • Flutter team linting rules
  • A clean pubspec.yaml file
  • Splash screen (Android and iOS)
  • App icons for all sizes (Android, iOS, web)
  • App display name

The following directions will give further details on how to do that.

General setup #

In this section you create your sample app with settings that will apply to all platforms.

Use the stable channel #

Make sure you're on the stable channel with the most recent version of Flutter.

flutter channel stable
flutter upgrade

Set the base package name #

Next create a Flutter project using the base package name for kodeco.com in reverse notation.

flutter create --org com.kodeco appname

Replace appname with your project name. This is used for both the Android package name and the iOS bundle identifier.

Add the Kodeco license #

The guides require adding the license to the top of each code file, but many developers expect to find a file called LICENSE in the root of the project also. So create that file. You can find the text for the file in this repository. Change the date to the current year if needed.

Set up linting rules #

Adding linting rules will help you to follow the Flutter team coding style and just write better code in general.

Add a file named analysis_options.yaml to the root of your project. Paste in the Flutter Team linting rules, which you can find in the root of this repository.

These linting rules will let your IDE give you warnings or errors if you aren't following the Flutter Team's coding style. This also means that you should fix all of the IDE warnings and errors before you submit your sample app.

Use .gitignore #

When you create a new Flutter project it comes with a good .gitignore file. Go with what's in there. Also consider this a good list of things not to include when you upload your project to kodeco.com.

Hint: If you develop your project with GitHub, all you have to do is download it from GitHub before uploading it to kodeco.com. This is an easy way to ensure that there are no unnecessary files in the project.

App display name #

Rather than having your launcher icon use your project name, which might be something unsightly like appname, you should update the display name for each platform that Flutter supports.

Testing it out #

Run the app on an Android and iOS device or emulator/simulator to make sure the splash screen, launcher icon and app name display correctly. If you don't have a Mac, then mention that on the Trello card so that the TE or FPE can double check the iOS version.

Run the Flutter web app in a browser to make sure that the favicon and app name show on the browser tab.

Future changes #

This guide is up to date for Flutter 2.0. When desktop versions enter the stable channel without the need for any special flags, the required resources should be added for them as well.

Are there new Flutter updates that break this guide? Please open a GitHub issue or submit a pull request.

0
likes
0
points
95
downloads

Publisher

unverified uploader

Weekly Downloads

This is package for heyinsight with notification features. @HeySheep

Homepage

License

unknown (license)

Dependencies

firebase_core, firebase_messaging, firebase_messaging_platform_interface, flutter, flutter_local_notifications

More

Packages that depend on heyinsight_package