fanoos_project 0.0.7

  • Readme
  • Changelog
  • Installing
  • 52

fanoos_project #

Everything you need to know to have a good flutter app structure.

Folder structure #

Small-Medium apps #

folder structure

lib

Contains the primary folders and a few primary dart files like main.dart & localization.dart.

assets

assets folder

Contains all external assets that are imported using the assets section of pubspec.yaml.

pages

pages simple

Contains all the pages.

In small to medium apps you can have all the pages in this folder.

services

pages simple

Contains view context independent app logic.

widgets

pages simple

Contains global widgets.

In smaller apps it contains all the widgets.

Large apps #

bigger apps

Larger apps may have more folders in lib.

here is two example extra folders that bigger projects may have:

themes

themes

Your app is probably not going to have a hundred themes, if it does, create reusable themes.

plugins

It is not recommended to write platform plugin in your project.

If you have to write your own plugin, for testing purposes, write it in the plugins folder then create a new flutter plugin project and migrate your code to there. if possible open source or publish that plugin to pub.dev.

State management #

Services #

Service do not have modified constructors. They cannot depend on BuildContext.

TODO: more explanation

Naming #

File names #

Format

type_name.dart

type_parent_name.dart

Class names #

Use camel case

Example

CalendarEventAdapter

Variable names #

variable
Example

monthEvents

constant or final
Example

day_in_month

Widget names #

Application core #

Folder structure #

[0.0.7] #

  • now using InheritedWidget

[0.0.6] #

  • removed scoped_model, now using the original fanoos_lib implementation

[0.0.5] #

  • removed AppRoute
  • added run to Services
  • services are now run in parallel in startup

[0.0.4] #

  • changed init to run
  • changed AppPage to AppRoute
  • added isSupported getter to AppService

[0.0.3] #

  • changed ServiceContainer to be more like App services in fanoos_lib
  • added app_page

[0.0.2] #

  • exporting models
  • changed Service to AppService

[0.0.1] #

  • initial release.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  fanoos_project: ^0.0.7

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:fanoos_project/fanoos_project.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
20
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
52
Learn more about scoring.

We analyzed this package on Jul 14, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.15
  • Flutter: 1.17.5

Analysis suggestions

Package not compatible with SDK dart

Because:

  • fanoos_project that is a package requiring null.

Health suggestions

Format lib/fanoos_project.dart.

Run flutter format to format lib/fanoos_project.dart.

Format lib/src/app_service.dart.

Run flutter format to format lib/src/app_service.dart.

Format lib/src/widget_services.dart.

Run flutter format to format lib/src/widget_services.dart.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and fanoos_project.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8 1.2.2
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8 2.1.0-nullsafety
Dev dependencies
flutter_test