hawkkiller / sizzle_starter

Production ready template for flutter applications.

Sizzle Starter

Sizzle is a template for Flutter projects with a focus on simplicity, scalability and testability. It features a solid layered architecture, efficient dependencies management, set of useful utilities and a bunch of other goodies.

For documentation and more details, please visit sizzle.lazebny.io.

sizzle_starter's Issues

[FR]: `Create token refresh interceptor`

Requirements:

• reusable
• configurable
• extendable
• clear and commented

Document dependencies + repositories scope

[FR]: `Readme and changelog`

Fill readme and changelog

[FR]: `Setup firebase analytics`

[FR]: RestClient impl

Create rest client, generally, it is a wrapper on http lib and its client. It will check for exceptions, throw custom, if needed and of course, parse the data from JSON to Map.

• #114
• #115
• #116
• #117
• #124

[FR]: `Set up github action`

Use premade Github action from blaze_router.

[FR]: Recommended libraries

A list of libraries that are 100% useful and popular with experienced people.

[FR]: `setup .gitignore`

[FR]: Patterns, principles

A bunch of useful resources and links to understand the most needed principles in Software Development.

[FR]: `Bump version`

[FR]: `Document starter structures`

• #72
• #73
• #74
• #75
• #76
• #77
• #78
• #79
• #80
• #81
• #82
• #83
• #84
• #85
• #86

[FR]: Credits

Credits to authors whose materials I used a lot when writing this starter.

[FR]: `Remove platform folders`

Now, there are all packages (ios, android, web, linux, macos, windows) in the repository.
They are not needed, moreover, it is better to remove them at all, so you can add only platforms that your app aims to.

---

The idea is to delete all folders because of their complexity and unsuitability.

[FR]: `Introduce rules for designing PRs and issues`

The author sees how to do PR properly with certain rules.

Document logger

Document App Runner

[FR]: `Useful libraries`

Add useful libraries, e.g. firebase, drift, shared preferences, intl, etc.

Document ScopeMixin

[FR]: `Implement initializing solution`

We need an initializing solution for repos, dependencies, etc.
To my mind, it should be scalable and reusable, so we are able to use it in different places.

---

Idea

Given some business logic or an initializing helper entity that takes initialization steps.
The step is a map <String, SomeStepModel>.
The idea is to invent such an instrument that can be used for initializing dependencies(firstly), then after success init, initialize repositories.

[FR]: create feature template

[FR]: Describe milestones in Wiki

Introduce rules for the milestones in the Wiki

Document Router

[FR]: `Setup sentry`

[FR]: `Runners for platfrorms`

Create runners for web and IO using deferred imports.

Document Initialization Hook

Document Scopes Provider

[FR]: `Set up right folders structure`

Document AppLocalization

[FR]: How to properly learn

Guides for newbies and people interested in flutter. But it could be also important for people with experience.

Document Initialization Progress + other initialization models

[BUG]: `l10n.yaml configuration is wrong`

There is a wrong path in l10n.yaml configuration.

[FR]: `Theming`

[FR]: `Set up linter`

Document Environment

[FR]: Description in github and in readme

General project description. Goals, ideas, etc.

Document Initialization Steps

[FR]: `Setup build.yaml`

Setup build.yaml for different generators to not to trigger on all the code.

Document Environment Store

[FR]: `Add GoRouter and GoRouteBuilder`

Add go router to the project and goRouteBuilder. Implement 1+ screens.

[FR]: Not recommended libraries

A list of bad and not recommended libraries to use. Especially important for newbies, juniors.

Document tracking manager

[FR]: `Improve readme`

It is needed to improve readme:

• tell about structures, general logic, components, etc.
• how to start a project, what commands
• useful libraries and their description
• how to use tools, like rename, native_splash, etc.
• general guides, tips

Document Initialization Processor

[FR]: `Create feature example`

Create an example for the feature.

• Model
• BLoC
• Widget
• Data(repo+datasource)

[FR]: Drawbacks & pitfolls

Tips how you should not do.

[FR]: Setup lints

[FR]: `Setup l10n`

Setup l10n using intl and flutter code generation.

Document Initialization Factory

[FR]: Tips, resources

Possibly some tips for flutter.
Even more resources to learn and advanced themes.

[FR]: `.gitignore setup`