Merge pull request #590 from stefandevo/master

Contribution videos and articles in Readme

Merge pull request #590 from stefandevo/master
Contribution videos and articles in Readme
Jonny Borges · GitHub
Commit 46e2df232f6d967f2f48637992c0bb4d873a4099 46e2df23 2 parents 0f604cbb e1098f82
Showing 1 changed file with 81 additions and 63 deletions
README.md
--- a/README.md
View file @46e2df2
+++ b/README.md
View file @46e2df2
 ![](get.png)
-*Languages: English (this file), [Brazilian Portuguese](README.pt-br.md), [Spanish](README-es.md),[Polish](README.pl.md).*
+_Languages: English (this file), [Brazilian Portuguese](README.pt-br.md), [Spanish](README-es.md),[Polish](README.pl.md)._
 [![pub package](https://img.shields.io/pub/v/get.svg?label=get&color=blue)](https://pub.dev/packages/get)
 ![building](https://github.com/jonataslaw/get/workflows/build/badge.svg)
@@ -9,7 +9,7 @@
 [![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://communityinviter.com/apps/getxworkspace/getx)
 [![Telegram](https://img.shields.io/badge/chat-on%20Telegram-blue.svg)](https://t.me/joinchat/PhdbJRmsZNpAqSLJL6bH7g)
 <a href="https://github.com/Solido/awesome-flutter">
-   <img alt="Awesome Flutter" src="https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square" />
+<img alt="Awesome Flutter" src="https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square" />
 </a>
 <a href="https://www.buymeacoffee.com/jonataslaw" target="_blank"><img src="https://i.imgur.com/aV6DDA7.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important; box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" > </a>
@@ -22,28 +22,40 @@
   - [State management](#state-management)
     - [Reactive State Manager](#reactive-state-manager)
     - [More details about state management](#more-details-about-state-management)
-    - [Video explanation about state management](#video-explanation-about-state-management)
   - [Route management](#route-management)
     - [More details about route management](#more-details-about-route-management)
-    - [Video Explanation](#video-explanation)
   - [Dependency management](#dependency-management)
     - [More details about dependency management](#more-details-about-dependency-management)
-- [How to contribute](#how-to-contribute)
 - [Utils](#utils)
   - [Internationalization](#internationalization)
+    - [Translations](#translations)
+      - [Using translations](#using-translations)
+    - [Locales](#locales)
+      - [Change locale](#change-locale)
+      - [System locale](#system-locale)
   - [Change Theme](#change-theme)
   - [Other Advanced APIs](#other-advanced-apis)
     - [Optional Global Settings and Manual configurations](#optional-global-settings-and-manual-configurations)
-  - [Video explanation of Other GetX Features](#video-explanation-of-other-getx-features)  
+    - [Local State Widgets](#local-state-widgets)
+      - [ValueBuilder](#valuebuilder)
+      - [ObxValue](#obxvalue)
+  - [Useful tips](#useful-tips)
+      - [GetView](#getview)
+      - [GetWidget](#getwidget)
+      - [GetxService](#getxservice)
 - [Breaking changes from 2.0](#breaking-changes-from-20)
 - [Why Getx?](#why-getx)
-
+- [Community](#community)
+  - [Community channels](#community-channels)
+  - [How to contribute](#how-to-contribute)
+  - [Articles and videos](#articles-and-videos)
 # About Get
 - GetX is an extra-light and powerful solution for Flutter. It combines high performance state management, intelligent dependency injection, and route management in a quick and practical way.
 - GetX has 3 basic principles, this means that this is the priority for all resources in the library
+
   - **PERFORMANCE:** GetX is focused on performance and minimum consumption of resources. Benchmarks are almost always not important in the real world, but if you want, there is a consumption indicator here([benchmarks](https://github.com/jonataslaw/benchmarks)), where GetX does better than other state management approaches, for example. The difference is not large, but it shows our concern not to waste its resources.
   - **PRODUCTIVITY:** GetX uses an easy and pleasant syntax. No matter what you want to do, there is always an easier way with Getx. It will save hours of development, and will extract the maximum performance that your application can deliver
   - **ORGANIZATION:** GetX allows the total decoupling of the View, presentation logic, business logic, dependency injection, and navigation. You do not need context to navigate between routes, so you are not dependent on the widget tree (visualization) for this. You don't need context to access your controllers / blocks through an inheritedWidget, so you completely decouple your presentation logic and business logic from your visualization layer. You do not need to inject your Controllers/Models/Blocs classes into your widget tree through multiproviders, for this GetX uses its own dependency injection feature, decoupling the DI from its view completely.
@@ -51,25 +63,16 @@
     BLoC was a starting point for organizing code in Flutter, it separates business logic from visualization. Getx is a natural evolution of this, not only separating the business logic, but the presentation logic. Bonus injection of dependencies and routes are also decoupled, and the data layer is out of it all. You know where everything is, and all of this in an easier way than building a hello world.
     GetX is the easiest, most practical and scalable way to build high-performance applications with the Flutter SDK, with a large ecosystem around it that works perfectly together, being easy for beginners, and accurate for experts. It is secure, stable, up-to-date, and offers a huge range of APIs build-in that are not present on default Flutter SDK.
-
 - GetX is not a bloated. It has a multitude of features that allow you to start programming without worrying about anything, but each of these features are in separate containers, and are only started after use. If you only use State Management, only State Management will be compiled. If you only use routes, nothing from the state management will be compiled. You can compile the benchmark repository, and you will see that using only Get state management, the application compiled with Get has become smaller than all other applications that have only the state management of other packages, because nothing that is not used will be compiled into your code, and each GetX solution was designed to be extra lightweight. The merit here also comes from Flutter's tree shaking which is incredible, and manages to eliminate unused resources like no other framework does.
 - Getx has a huge ecosystem, capable of running with the same code on Android, iOS, Web, Mac, Linux, Windows, and on your server.
-It is possible to fully reuse your code made on the frontend on your backend with **[Get Server](https://github.com/jonataslaw/get_server)**.
+  It is possible to fully reuse your code made on the frontend on your backend with **[Get Server](https://github.com/jonataslaw/get_server)**.
 In addition, the entire development process can be completely automated, both on the server and on the front end with **[Get CLI](https://github.com/jonataslaw/get_cli)**.
 In addition, to further increase your productivity, we have the
 **[extension to VSCode](https://marketplace.visualstudio.com/items?itemName=get-snippets.get-snippets)** and the **[extension to Android Studio/Intellij](https://plugins.jetbrains.com/plugin/14975-getx-snippets)**
-**GetX Community channels:**
-
-GetX has a highly active and helpful community. If you have questions, or would like any assistance regarding the use of this framework, please join our community channels, your question will be answered more quickly, and it will be the most suitable place. This repository is exclusive for opening issues, and requesting resources, but feel free to be part of GetX Community.
-
-| **Slack** | **Discord** | **Telegram** |
-| --------- | ------------| ------------ |
-| [![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://communityinviter.com/apps/getxworkspace/getx) | [![Discord Shield](https://img.shields.io/discord/722900883784073290.svg?logo=discord)](https://discord.com/invite/9Hpt99N) | [![Telegram](https://img.shields.io/badge/chat-on%20Telegram-blue.svg)](https://t.me/joinchat/PhdbJRmsZNpAqSLJL6bH7g) |
-
 # Installing
 Add Get to your pubspec.yaml file:
@@ -84,12 +87,13 @@ Import get in files that it will be used:
 ```dart
 import 'package:get/get.dart';
 ```
+
 # Counter App with GetX
 The "counter" project created by default on new project on Flutter has over 100 lines (with comments). To show the power of Get, I will demonstrate how to make a "counter" changing the state with each click, switching between pages and sharing the state between screens, all in an organized way, separating the business logic from the view, in ONLY 26 LINES CODE INCLUDING COMMENTS.
 - Step 1:
-Add "Get" before your MaterialApp, turning it into GetMaterialApp
+  Add "Get" before your MaterialApp, turning it into GetMaterialApp
 ```dart
 void main() => runApp(GetMaterialApp(home: Home()));
@@ -99,8 +103,8 @@ void main() => runApp(GetMaterialApp(home: Home()));
 - Note²: This step in only necessary if you gonna use route management (`Get.to()`, `Get.back()` and so on). If you not gonna use it then it is not necessary to do step 1
 - Step 2:
-Create your business logic class and place all variables, methods and controllers inside it.
-You can make any variable observable using a simple ".obs".
+  Create your business logic class and place all variables, methods and controllers inside it.
+  You can make any variable observable using a simple ".obs".
 ```dart
 class Controller extends GetxController{
@@ -110,7 +114,7 @@ class Controller extends GetxController{
 ```
 - Step 3:
-Create your View, use StatelessWidget and save some RAM, with Get you may no longer need to use StatefulWidget.
+  Create your View, use StatelessWidget and save some RAM, with Get you may no longer need to use StatefulWidget.
 ```dart
 class Home extends StatelessWidget {
@@ -195,20 +199,14 @@ And in the UI, when you want to show that value and update the screen whenever t
 Obx(() => Text("${controller.name}"));
 ```
-That's all. It's *that* simple.
+That's all. It's _that_ simple.
 ### More details about state management
 **See an more in-depth explanation of state management [here](./documentation/en_US/state_management.md). There you will see more examples and also the difference between the simple stage manager and the reactive state manager**
-### Video explanation about state management
-
-
-Amateur Coder did an awesome video about state management! Link: [Complete GetX State Management](https://www.youtube.com/watch?v=CNpXbeI_slw)
-
 You will get a good idea of GetX power.
-
 ## Route management
 If you are going to use routes/snackbars/dialogs/bottomsheets without context, GetX is excellent for you too, just see it:
@@ -220,7 +218,9 @@ GetMaterialApp( // Before: MaterialApp(
   home: MyHome(),
 )
 ```
+
 Navigate to new screen:
+
 ```dart
 Get.to(NextScreen());
@@ -250,10 +250,6 @@ Noticed that you didn't had to use context to do any of these things? That's one
 **Get work with named routes and also offer a lower level control over your routes! There is a in-depth documentation [here](./documentation/en_US/route_management.md)**
-### Video Explanation
-
-Amateur Coder did an excellent video that cover route management with Get! here is the link: [Complete Getx Navigation](https://www.youtube.com/watch?v=RaqPIoJSTtI)
-
 ## Dependency management
 Get has a simple and powerful dependency manager that allows you to retrieve the same class as your Bloc or Controller with just 1 lines of code, no Provider context, no inheritedWidget:
@@ -267,7 +263,6 @@ Controller controller = Get.put(Controller()); // Rather Controller controller =
 Instead of instantiating your class within the class you are using, you are instantiating it within the Get instance, which will make it available throughout your App.
 So you can use your controller (or class Bloc) normally
-
 **Tip:** Get dependency management is decloupled from other parts of the package, so if for example your app is already using a state manager (any one, it doesn't matter), you don't need to rewrite it all, you can use this dependency injection with no problems at all
 ```dart
@@ -291,23 +286,15 @@ Text(controller.textFromApi);
 **See a more in-depth explanation of dependency management [here](./documentation/en_US/dependency_management.md)**
-# How to contribute
-
-*Want to contribute to the project? We will be proud to highlight you as one of our collaborators. Here are some points where you can contribute and make Get (and Flutter) even better.*
-
-- Helping to translate the readme into other languages.
-- Adding documentation to the readme (a lot of Get's functions haven't been documented yet).
-- Write articles or make videos teaching how to use Get (they will be inserted in the Readme and in the future in our Wiki).
-- Offering PRs for code/tests.
-- Including new functions.
-
-Any contribution is welcome!
-
 # Utils
+
 ## Internationalization
+
 ### Translations
+
 Translations are kept as a simple key-value dictionary map.
 To add custom translations, create a class and extend `Translations`.
+
 ```dart
 import 'package:get/get.dart';
@@ -325,12 +312,15 @@ class Messages extends Translations {
 ```
 #### Using translations
+
 Just append `.tr` to the specified key and it will be translated, using the current value of `Get.locale` and `Get.fallbackLocale`.
+
 ```dart
 Text('title'.tr);
 ```
 ### Locales
+
 Pass parameters to `GetMaterialApp` to define the locale and translations.
 ```dart
@@ -343,14 +333,18 @@ return GetMaterialApp(
 ```
 #### Change locale
+
 Call `Get.updateLocale(locale)` to update the locale. Translations then automatically use the new locale.
+
 ```dart
 var locale = Locale('en', 'US');
 Get.updateLocale(locale);
 ```
 #### System locale
+
 To read the system locale, you could use `window.locale`.
+
 ```dart
 import 'dart:ui' as ui;
@@ -370,6 +364,7 @@ Get.changeTheme(ThemeData.light());
 ```
 If you want to create something like a button that changes the Theme in `onTap`, you can combine two **GetX™** APIs for that:
+
 - The api that checks if the dark `Theme` is being used.
 - And the `Theme` Change API, you can just put this within an `onPressed`:
@@ -379,10 +374,6 @@ Get.changeTheme(Get.isDarkMode? ThemeData.light(): ThemeData.dark());
 When `.darkmode` is activated, it will switch to the _light theme_, and when the _light theme_ becomes active, it will change to _dark theme_.
-If you want to know in depth how to change the Theme, you can follow this tutorial on Medium which even teaches the persistence of the theme using **GetX™**:
-
-- [Dynamic Themes in 3 lines using Get](https://medium.com/swlh/flutter-dynamic-themes-in-3-lines-c3b375f292e3) - Tutorial by [Rod Brown](https://github.com/RodBr).
-
 ## Other Advanced APIs
 ```dart
@@ -587,6 +578,7 @@ Expandable Panel, or maybe modify the current index in `BottomNavigationBar` whi
 of the body in a `Scaffold`.
 #### ValueBuilder
+
 A simplification of `StatefulWidget` that works with a `.setState` callback that takes the updated value.
 ```dart
@@ -603,6 +595,7 @@ ValueBuilder<bool>(
 ```
 #### ObxValue
+
 Similar to [`ValueBuilder`](#valuebuilder), but this is the Reactive version, you pass a Rx instance (remember the magical .obs?) and
 updates automatically... isn't it awesome?
@@ -617,16 +610,17 @@ ObxValue((data) => Switch(
 ## Useful tips
-
 `.obs`ervables (also known as _Rx_ Types) have a wide variety of internal methods and operators.
 > Is very common to _believe_ that a property with `.obs` **IS** the actual value... but make no mistake!
-We avoid the Type declaration of the variable, because Dart's compiler is smart enough, and the code
-looks cleaner, but:
+> We avoid the Type declaration of the variable, because Dart's compiler is smart enough, and the code
+> looks cleaner, but:
+
 ```dart
 var message = 'Hello world'.obs;
 print( 'Message "$message" has Type ${message.runtimeType}');
 ```
+
 Even if `message` _prints_ the actual String value, the Type is **RxString**!
 So, you can't do `message.substring( 0, 4 )`.
@@ -767,7 +761,6 @@ If you use, another "not so common" feature of **GetX**: `Get.create()`.
 That's where `GetWidget` shines... as you can use it, for example,
 to keep a list of Todo items. So, if the widget gets "rebuilt", it will keep the same controller instance.
-
 #### GetxService
 This class is like a `GetxController`, it shares the same lifecycle ( `onInit()`, `onReady()`, `onClose()`).
@@ -819,16 +812,6 @@ The only way to actually delete a `GetxService`, is with `Get.reset()` which is 
 "Hot Reboot" of your app. So remember, if you need absolute persistance of a class instance during the
 lifetime of your app, use `GetxService`.
-
- 
-
-
-## Video explanation of Other GetX Features
-
-
-Amateur Coder did an awesome video about utils, storage, bindings and other features! Link: [GetX Other Features](https://youtu.be/ttQtlX_Q0eU)
-
-
 # Breaking changes from 2.0
 1- Rx types:
@@ -894,3 +877,38 @@ GetMaterialApp(
 If you need context to find an InheritedWidget, you need it in the view, or pass the context by parameter. I particularly find this solution very ugly, and to work in teams we will always have a dependence on View's business logic. Getx is unorthodox with the standard approach, and while it does not completely ban the use of StatefulWidgets, InitState, etc., it always has a similar approach that can be cleaner. Controllers have life cycles, and when you need to make an APIREST request for example, you don't depend on anything in the view. You can use onInit to initiate the http call, and when the data arrives, the variables will be populated. As GetX is fully reactive (really, and works under streams), once the items are filled, all widgets that use that variable will be automatically updated in the view. This allows people with UI expertise to work only with widgets, and not have to send anything to business logic other than user events (like clicking a button), while people working with business logic will be free to create and test the business logic separately.
 This library will always be updated and implementing new features. Feel free to offer PRs and contribute to them.
+
+# Community
+
+## Community channels
+
+GetX has a highly active and helpful community. If you have questions, or would like any assistance regarding the use of this framework, please join our community channels, your question will be answered more quickly, and it will be the most suitable place. This repository is exclusive for opening issues, and requesting resources, but feel free to be part of GetX Community.
+
+| **Slack**                                                                                                                   | **Discord**                                                                                                                 | **Telegram**                                                                                                          |
+| :-------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------- |
+| [![Get on Slack](https://img.shields.io/badge/slack-join-orange.svg)](https://communityinviter.com/apps/getxworkspace/getx) | [![Discord Shield](https://img.shields.io/discord/722900883784073290.svg?logo=discord)](https://discord.com/invite/9Hpt99N) | [![Telegram](https://img.shields.io/badge/chat-on%20Telegram-blue.svg)](https://t.me/joinchat/PhdbJRmsZNpAqSLJL6bH7g) |
+
+## How to contribute
+
+_Want to contribute to the project? We will be proud to highlight you as one of our collaborators. Here are some points where you can contribute and make Get (and Flutter) even better._
+
+- Helping to translate the readme into other languages.
+- Adding documentation to the readme (a lot of Get's functions haven't been documented yet).
+- Write articles or make videos teaching how to use Get (they will be inserted in the Readme and in the future in our Wiki).
+- Offering PRs for code/tests.
+- Including new functions.
+
+Any contribution is welcome!
+
+## Articles and videos
+
+- [Dynamic Themes in 3 lines using GetX™](https://medium.com/swlh/flutter-dynamic-themes-in-3-lines-c3b375f292e3) - Tutorial by [Rod Brown](https://github.com/RodBr).
+- [Complete GetX™ Navigation](https://www.youtube.com/watch?v=RaqPIoJSTtI) - Route management video by Amateur Coder.
+- [Complete GetX State Management](https://www.youtube.com/watch?v=CNpXbeI_slw) - State management video by Amateur Coder.
+- [GetX™ Other Features](https://youtu.be/ttQtlX_Q0eU) - Utils, storage, bindings and other features video by Amateur Coder.
+- [Firestore User with GetX | Todo App](https://www.youtube.com/watch?v=BiV0DcXgk58) - Video by Amateur Coder.
+- [Firebase Auth with GetX | Todo App](https://www.youtube.com/watch?v=-H-T_BSgfOE) - Video by Amateur Coder.
+- [The Flutter GetX™ Ecosystem ~ State Management](https://medium.com/flutter-community/the-flutter-getx-ecosystem-state-management-881c7235511d) - State management by [Aachman Garg](https://github.com/imaachman).
+- [GetX, the all-in-one Flutter package](https://www.youtube.com/watch?v=IYQgtu9TM74) - A brief tutorial covering State Management and Navigation by Thad Carnevalli.
+- [Build a To-do List App from scratch using Flutter and GetX](https://www.youtube.com/watch?v=EcnqFasHf18) - UI + State Management + Storage video by Thad Carnevalli.
+- [GetX Flutter Firebase Auth Example](https://medium.com/@jeffmcmorris/getx-flutter-firebase-auth-example-b383c1dd1de2) - Article by Jeff McMorris.