Skip to content

Commit b6067cc

Browse files
committed
Update README.md and add pull request template
1 parent 33c8b9a commit b6067cc

File tree

3 files changed

+31
-14
lines changed

3 files changed

+31
-14
lines changed

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## 📄  Description:
2+
3+
A good description of the problem this PR addresses.
4+
5+
---
6+
7+
## 📌  Notes:
8+
9+
(Optional) Warnings, things other developers need to be aware of when merging, etc.
10+
11+
---
12+
13+
##   Demo:
14+
15+
Video or image.

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,43 @@
11
<br>
22
<br>
33
<p align="center">
4+
45
<img src="https://media-exp1.licdn.com/dms/image/C4D0BAQEU4y571j_M9w/company-logo_200_200/0/1654631302030?e=2147483647&v=beta&t=BsvDC8hQex8mbeHd23So2Skx8p2Gu6EyUlDXFdoyBj0" alt="sebastianpaz" height="200" />
56
<img src="https://codigoonclick.com/wp-content/uploads/2019/07/flutter-introducci%C3%B3n.jpg" alt="sebastianpaz" height="200" />
67
<img src="https://media-exp1.licdn.com/dms/image/C4D0BAQEU4y571j_M9w/company-logo_200_200/0/1654631302030?e=2147483647&v=beta&t=BsvDC8hQex8mbeHd23So2Skx8p2Gu6EyUlDXFdoyBj0" alt="sebastianpaz" height="200" />
78
</p>
89

910

10-
<h1 align="center">Flutter Template</h1>
11+
<h1 align="center">Flutter Boilerplate Template</h1>
1112
<h3 align="center">A solid and easy-to-use template to quickstart your next Flutter project</h3>
1213

13-
<br>
1414

1515
## ⚡ Introduction
16-
This project is a powerful Flutter starter template that aims to bootstrap the development of your mobile application. This template comes with a few built-in components, and a clean and organized folder structure for getting a quick ramp up on your Flutter application. This template is being constantly maintained and contributions are well accepted.
16+
This project is a powerful Flutter boilerplate project that aims to bootstrap the development of your mobile application. This boilerplate project comes with a few built-in components, and a clean and organized folder structure for getting a quick ramp up on your Flutter application. We are constantly maintaining this project and contributions are well accepted.
1717

1818
## ⭐ What's inside
1919
- Built with the latest major version of Flutter (and we'll keep it updated!)
20-
- Three screens with components and bottom navigation.
21-
- Authentication-based route resolver.
20+
- Three screens with common widgets and navigation
21+
- Authentication-based route resolver
2222
- Multi-language support
23-
- Built-in dark mode and multi-theme support.
24-
- Full SVG support
25-
23+
- Built-in dark mode and multi-theme with pixel-density-aware widget sizing
24+
- Ready for CI testing with Github Actions
25+
<a href="https://github.com/moove-it/flutter-template/actions"><img height="15" src="https://github.com/moove-it/flutter-template/actions/workflows/tests.yml/badge.svg" alt="Build Status">
26+
</a>
2627
### Business Logic and Data.
27-
- Layered pattern structure with Repository Pattern for data management.
28-
- BloC-driven architecture 🔥 for a solid state management with BloCs and Cubits.
29-
- Supports persistence and offline usage with HydratedBloC.
30-
- Provides secure storage for sensitive data
31-
- Provides key-pair value storage for user preferences.
28+
- Layered pattern structure with Repository Pattern for data management
29+
- BLoC-driven architecture 🔥 for a solid state management with BLoCs and Cubits
30+
- Supports persistence and offline usage with HydratedBLoC
31+
- Provides secure storage for sensitive data
32+
- Provides key-pair value storage for user preferences
3233

3334
## 📲 How to run
3435
1. Follow the [Getting started](https://docs.flutter.dev/get-started/install) section of the Flutter docs to setup your Flutter environment. Also, make sure you have installed Android and iOS simulators.
35-
2. Click the **Use this template** button at the top of this page and create a new repository from this template.
36+
2. Click the **Use this template** button at the top of this page and create a new repository from this boilerplate project.
3637
3. Go to your newly created repository and clone it.
3738
4. Run `flutter pub get` and `npx pod-install ios`.
3839
5. Run `flutter run`
40+
6. _(Optional):_ Rename your project using the [rename](https://pub.dev/packages/rename) package.
3941

4042
## 📷 Screenshots
4143
| ![]( https://sp-flutter-template.s3.amazonaws.com/1.png ) | ![]( https://sp-flutter-template.s3.amazonaws.com/2.png ) | ![]( https://sp-flutter-template.s3.amazonaws.com/3.png ) | ![]( https://sp-flutter-template.s3.amazonaws.com/4.png ) | |

0 commit comments

Comments
 (0)