🚧 fix readme file

This commit is contained in:
Nishant Srivastava
2019-12-26 01:42:17 +01:00
parent 5a8b0f1d8b
commit 4d23f7c82f

100
README.md
View File

@ -18,36 +18,36 @@ Lookup Links: [[Setup Flutter](https://flutter.io/setup/)] [[Widgets Catalog](ht
## Example apps
1. [Simple Material App](/simple_material_app) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/simple_material_app)
1. [Using Theme](/using_theme) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_theme)
1. [Stateless Widgets](/stateless_widgets) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/stateless_widgets)
1. [Stateful Widget](/stateful_widget) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/stateful_widget)
1. [Using EditText](/using_edittext) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_edittext)
1. [Load local image](/load_local_image) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/load_local_image)
1. [Load local json](/load_local_json) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/load_local_json)
1. [Using HTTP GET](/using_http_get) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_http_get)
1. [Using Alert Dialog](/using_alert_dialog) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_alert_dialog)
1. [Using Stepper](/using_stepper) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_stepper)
1. [Using Tabs](/using_tabs) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_tabs)
1. [Using Bottom Navigation Bar](/using_bottom_nav_bar) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_bottom_nav_bar)
1. [Using Custom Fonts](/using_custom_fonts) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_custom_fonts)
1. [Using Gradient](/using_gradient) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_gradient)
1. [Navigation Drawer](/navigation_drawer) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/navigation_drawer)
1. [Enable Splash Screen](/enabling_splash_screen) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/enabling_splash_screen)
1. [Using Listview](/using_listview) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_listview)
1. [Using SnackBar](/using_snackbar) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_snackbar)
1. [Grid Layout](/grid_layout) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/grid_layout)
1. [DropDown Button](/dropdown_button) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/dropdown_button)
1. [Image from Network](/image_from_network) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/image_from_network)
1. [Infinite List](/infinite_list) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/infinite_list)
1. [Google Signin](/google_signin) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/google_signin)
1. [Persist Key Value](/persist_key_value) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/persist_key_value)
1. [Simple Material App](/simple_material_app)
1. [Using Theme](/using_theme)
1. [Stateless Widgets](/stateless_widgets)
1. [Stateful Widget](/stateful_widget)
1. [Using EditText](/using_edittext)
1. [Load local image](/load_local_image)
1. [Load local json](/load_local_json)
1. [Using HTTP GET](/using_http_get)
1. [Using Alert Dialog](/using_alert_dialog)
1. [Using Stepper](/using_stepper)
1. [Using Tabs](/using_tabs)
1. [Using Bottom Navigation Bar](/using_bottom_nav_bar)
1. [Using Custom Fonts](/using_custom_fonts)
1. [Using Gradient](/using_gradient)
1. [Navigation Drawer](/navigation_drawer)
1. [Enable Splash Screen](/enabling_splash_screen)
1. [Using Listview](/using_listview)
1. [Using SnackBar](/using_snackbar)
1. [Grid Layout](/grid_layout)
1. [DropDown Button](/dropdown_button)
1. [Image from Network](/image_from_network)
1. [Infinite List](/infinite_list)
1. [Google Signin](/google_signin)
1. [Persist Key Value](/persist_key_value)
### Complete apps with multiple features
1. [Tip Calculator](/tip_calculator) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/tip_calculator)
2. [Expense Planner](/expense_planner) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/expense_planner)
2. [Notes App](/using_firebase_db) [![download](img/ic_download.png)](https://kinolien.github.com/gitzip/?download=https://github.com/nisrulz/flutter-examples/tree/master/using_firebase_db)
1. [Tip Calculator](/tip_calculator)
1. [Expense Planner](/expense_planner)
1. [Notes App](/using_firebase_db)
# Get packages for all flutter projects
@ -60,27 +60,41 @@ Lookup Links: [[Setup Flutter](https://flutter.io/setup/)] [[Widgets Catalog](ht
I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:
1. Match coding style (braces, spacing, etc.) This is best achieved using `Reformat Code` feature of Android Studio `CMD`+`Option`+`L` on Mac and `CTRL` + `ALT` + `L` on Linux + Windows .
2. If its a feature, bugfix, or anything please only change code to what you specify.
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
4. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.
5. Check for existing [issues](https://github.com/nisrulz/flutter-examples/issues) first, before filing an issue.
6. Make sure you follow the set standard as all other projects in this repo do
1. Match coding style (braces, spacing, etc.) This is best achieved using `Reformat Code` feature of Android Studio `CMD`+`Option`+`L` on Mac and `CTRL` + `ALT` + `L` on Linux + Windows .
1. If its a feature, bugfix, or anything please only change code to what you specify.
1. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
1. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.
1. Check for existing [issues](https://github.com/nisrulz/flutter-examples/issues) first, before filing an issue.
1. Make sure you follow the set standard as all other projects in this repo do
> Make sure the package name conforms to the format: `github.nisrulz.<app_name>`
7. Have fun!
1. Have fun!
> P.S. : I saw if you use Adblocker then Gitzip downloads an empty `zip` file, so disable Adblocker to get the correct `zip` file.
### Created & Maintained By
## Extra
Since the repo is pretty large now , I am sure many folks would like to download only some of the projects. To tackle that follow the steps below:
- Install `svn` using homebrew (mac/linux)
```bash
brew install svn
```
- Copy the name of the example folder in this repo i.e `simple_material_app`
- Next replace `example_folder` in the below command:
[Nishant Srivastava](https://github.com/nisrulz) ([@nisrulz](https://www.twitter.com/nisrulz))
```bash
svn checkout https://github.com/nisrulz/flutter-examples/trunk/example_folder
```
i.e Consider `simple_material_app` is the name of the example's folder, the command becomes:
```bash
svn checkout https://github.com/nisrulz/flutter-examples/trunk/simple_material_app
```
- Done! You should have the specific example all checked out!
> If you found these examples helpful or you learned something from their source code and want to thank me, consider buying me a cup of :coffee:
>
> - [PayPal](https://www.paypal.me/nisrulz/5usd)
> - Bitcoin Address: 13PjuJcfVW2Ad81fawqwLtku4bZLv1AxCL
## Author & support
This project was created by [Nishant Srivastava](https://github.com/nisrulz/nisrulz.github.io#nishant-srivastava) but hopefully developed and maintained by many others. See the [the list of contributors here](https://github.com/nisrulz/flutter-examples/graphs/contributors).
# License
If you appreciate my work, consider [buying me](https://www.paypal.me/nisrulz/5usd) a cup of :coffee: to keep me recharged :metal: [[PayPal](https://www.paypal.me/nisrulz/5usd)]
License
=======
Copyright 2017 Nishant Srivastava
@ -94,4 +108,4 @@ I welcome and encourage all pull requests. It usually will take me within 24-48
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
limitations under the License.