geekyants/flutter-starter

A Flutter starter-kit for production-level apps.

Flutter Starter

Introduction

We wanted to take Flutter a step further and accelerate the process of building production-level apps. Presenting our solution- Flutter Starter!

Flutter Starter, as the name suggests, is a starter kit for Flutter that helps you bootstrap projects with all the essential modules like State Management, API calls, Style Guide, etc. It helps you build production ready apps in a jiffy. Handle everything at one place so you don't have to rewrite code.

Motivation

Flutter gives us a simple counter app on installation which works if you are just starting out. However, while building a production-level app, we need state-management, API calls, Styleguide and common widgets. We frequently repeat this code in every project.

Flutter Starter is based on the DRY principle. Don't Repeat Yourself is a programming principle that is aimed at reducing repetition and redundancy.

💡 The DRY principle states that "Every piece of knowledge must have a single, unambiguous, authoritative representation within a system".

Why is this useful? Applying the DRY principle helps code maintainability, improves development efficiency and much more!

Features

• Folder Structure: Flutter Starter comes with a well-defined folder structure. Devs can easily navigate it and add files where necessary.

• Style Guide: This kit helps you to build a Style Guide for your app. You can add your image and font assets, splash screen, color constants and theme data. These are available for use wherever required in your project.

• API Calls: The starter kit includes all the files you need for API handling. You can choose from REST, GraphQL and Firebase depending on your project.

• State Management: Flutter Starter contains all the state management files, models and repositories for your app. We will use Bloc for state management.

• Routers & Dependencies: This kit allows you to quickly add routers for your app screens. Dependencies can also be added to your app by simply copy-pasting the install version from pub.dev into the designated file.

• Testing & Deployment: Lastly, you can test and deploy your app smoothly using Flutter Starter! Go to the test folder, add your test files and start writing test cases. Check out the Android or iOS pages to deploy your app.

Installing & Usage

Go to Flutter and install Flutter on your system. Proceed to our Github repository and create a template.

To run the project, run:

bash run_script.sh

💡 You can build apps with Flutter using any text editor combined with our command-line tools. We use VS Code since it is lightweight.

Examples

Here are some of the example apps made using Flutter Starter:

• HackerNews App

• GithubRepo List App

• Weather App

Tech Stack

Flutter, Firebase, GraphQL, REST and Bloc.

Naming Conventions

• Variables: camelCase
• Classes: PascalCase
• Files: snake_case

Build Status

Check out our roadmap here.

Contributors

Sumant Raj 💻

madhav23bansal 💻

How to Contribute

Thank you for your interest in contributing to Flutter Starter! We are lucky to have you 🙂 Head over to Contribution Guidelines and learn how you can be a part of a wonderful, growing community.

License

Licensed under the MIT License, Copyright © 2020 GeekyAnts. See LICENSE for more information.

flutter-starter's Issues

github pipeline ?

hi guys,
would it be possible for you to add a github pipeline config here ? including for production ?

i realise that the pipeline run would cost money, so you could just add the .github directory under some other name. it would be super helpful to use this repo.

Please update all packages to the latest versions + Android updates

Missing update to android v2

Getting: "This app is using a deprecated version of the Android embedding." error

Not compiling

+++++Main app pub get+++++
Running "flutter pub get" in app... 1,253ms
The plugin cloud_firestore uses a deprecated version of the Android embedding.
To avoid unexpected runtime failures, or future build failures, try to see if this plugin supports the Android V2 embedding. Otherwise, consider removing it since a future
release of Flutter will remove these deprecated APIs.
If you are plugin author, take a look at the docs for migrating the plugin to the V2 embedding: https://flutter.dev/go/android-plugin-migration.
+++++Main app run+++++
The plugin cloud_firestore uses a deprecated version of the Android embedding.
To avoid unexpected runtime failures, or future build failures, try to see if this plugin supports the Android V2 embedding. Otherwise, consider removing it since a future
release of Flutter will remove these deprecated APIs.
If you are plugin author, take a look at the docs for migrating the plugin to the V2 embedding: https://flutter.dev/go/android-plugin-migration.
Using hardware rendering with device sdk gphone x86 arm. If you notice graphics artifacts, consider enabling software rendering with "--enable-software-rendering".
Launching lib/main.dart on sdk gphone x86 arm in debug mode...
Plugin project :firebase_core_web not found. Please update settings.gradle.
Plugin project :firebase_auth_web not found. Please update settings.gradle.
../../flutter-sdk/flutter/.pub-cache/hosted/pub.dartlang.org/uuid_enhanced-3.0.2/lib/uuid.dart:9:7: Error: 'UnmodifiableUint8ListView' is restricted and can't be extended or implemented.

../shared/lib/modules/authentication/models/firebase_user.dart:8:10: Error: The parameter 'uid' can't have a value of 'null' because of its type 'String', but the implicit default value is 'null'.
Try adding either an explicit non-'null' default value or the 'required' modifier.
this.uid,
^^^
../shared/lib/modules/authentication/models/firebase_user.dart:9:10: Error: The parameter 'email' can't have a value of 'null' because of its type 'String', but the implicit default value is 'null'.
Try adding either an explicit non-'null' default value or the 'required' modifier.
this.email,
^^^^^
../shared/lib/modules/authentication/models/firebase_user.dart:10:10: Error: The parameter 'token' can't have a value of 'null' because of its type 'String', but the implicit default value is 'null'.
Try adding either an explicit non-'null' default value or the 'required' modifier.
this.token,
^^^^^
../shared/lib/modules/authentication/bloc/authentication/authentication_event.dart:21:30: Error: The parameter 'email' can't have a value of 'null' because of its type 'String', but the implicit default value is 'null'.
Try adding either an explicit non-'null' default value or the 'required' modifier.
UserSignUp({@required this.email, this.password});
^^^^^
../shared/lib/modules/authentication/bloc/authentication/authentication_event.dart:21:42: Error: The parameter 'password' can't have a value of 'null' because of its type 'String', but the implicit default value is 'null'.
Try adding either an explicit non-'null' default value or the 'required' modifier.
UserSignUp({@required this.email, this.password});
^^^^^^^^
../shared/lib/modules/authentication/bloc/authentication/authentication_event.dart:30:29: Error: The parameter 'email' can't have a value of 'null' because of its type 'String', but the implicit default value is 'null'.
Try adding either an explicit non-'null' default value or the 'required' modifier.
UserLogin({@required this.email, this.password});

deprecated version of Android embedding -- migrate to V2 embedding

Hey guys, I'm pretty new to flutter (mainly experienced in iOS Swift, Ruby, and JavaScript -- but dabbled in some Flutter examples). Want to build a cross-platform app in Flutter without reinventing the wheel/starting from scratch. This starter app is a really awesome idea and you guys have some amazing docs and presentation -- thanks for doing this!

I just cloned this today and am getting an error that the Android embedding version has been deprecated. If it's only for Firebase, I don't plan to use that anyway, as I plan to build my own REST API backend. However, I have absolutely no idea about this architecture! It would be awesome if this template could possibly be fixed/updated to use the new embedding API. Or, could it be something on my end? I'm running an M1 MacBook Pro with the following Flutter:

flutter doctor                    04/9 12:13:37
Doctor summary (to see all details, run flutter doctor -v):
[✓] Flutter (Channel beta, 2.12.0-4.1.pre, on macOS 12.3.1 21E258
    darwin-arm, locale en-US)
[✓] Android toolchain - develop for Android devices (Android SDK version
    32.1.0-rc1)
[✓] Xcode - develop for iOS and macOS (Xcode 13.3)
[✓] Chrome - develop for the web
[✓] Android Studio (version 2021.1)
[✓] IntelliJ IDEA Community Edition (version 2021.3.2)
[✓] VS Code (version 1.66.1)
[✓] Connected device (2 available)
[✓] HTTP Host Availability

• No issues found!

This is my run output:

bash run_script.sh                 04/9 12:12:40
+++++API SDK pub clean+++++
+++++API SDK pub get+++++
Running "flutter pub get" in api_sdk...                            13.8s
+++++API SDK done+++++
+++++Shared pub clean+++++
+++++Shared pub get+++++
Running "flutter pub get" in shared...                           2,866ms
+++++Shared done+++++
+++++Main app pub clean+++++
Cleaning Xcode workspace...                                      1,492ms
+++++Main app pub get+++++
Running "flutter pub get" in app...                                 5.9s
This app is using a deprecated version of the Android embedding.
To avoid unexpected runtime failures, or future build failures, try to
migrate this app to the V2 embedding.
Take a look at the docs for migrating an app:
https://github.com/flutter/flutter/wiki/Upgrading-pre-1.12-Android-projects
The plugin `cloud_firestore` requires your app to be migrated to the
Android embedding v2. Follow the steps on
https://flutter.dev/go/android-project-migration and re-run this command.
+++++Main app run+++++
This app is using a deprecated version of the Android embedding.
To avoid unexpected runtime failures, or future build failures, try to
migrate this app to the V2 embedding.
Take a look at the docs for migrating an app:
https://github.com/flutter/flutter/wiki/Upgrading-pre-1.12-Android-projects
The plugin `cloud_firestore` requires your app to be migrated to the
Android embedding v2. Follow the steps on
https://flutter.dev/go/android-project-migration and re-run this command.

this repo is far behind than latest flutter, suggest don't generate project base on this

.DS_Store

In the route folder (as well as in many sub folders) you have a file called .DS_Store as these refer to Mac's file folder and has nothing to do with flutter, it might be better to remove such files. Personally I find these files a right pain in the neck when I transfer files from my MacBook to Windows.

The following web page describes how you can disabled them on a mac:

https://www.techrepublic.com/article/how-to-disable-the-creation-of-dsstore-files-for-mac-users-folders/