|
1 |
| -# ns_firebase_utils |
| 1 | +# Flutter Firebase Utilities |
2 | 2 |
|
3 |
| -🦾 Set of methods/extensions for firebase that makes using framework in a much easier and clean way also adds additional functionality. |
| 3 | +🚀 This package provides a comprehensive set of methods and extensions for Firebase, simplifying its integration into your Flutter projects while also adding valuable functionality. |
4 | 4 |
|
5 |
| -###Contributors |
6 |
| -<br> |
7 |
| -<div align="center" > |
8 |
| - <a href="https://github.com/ProjectAJ14/ns_firebase_utils/graphs/contributors"> |
9 |
| - <img src="https://contrib.rocks/image?repo=ProjectAJ14/ns_firebase_utils" /> |
10 |
| - </a> |
11 |
| -</div> |
12 |
| -<br> |
13 |
| - |
14 |
| -## Let's get started |
| 5 | +## Getting Started |
15 | 6 |
|
16 |
| -1. Go to `pubspec.yaml` |
17 |
| -2. add a ns_firebase_utils and replace `[version]` with the latest version: |
| 7 | +1. Open your `pubspec.yaml` file. |
| 8 | +2. Add `ns_firebase_utils` as a dependency, replacing `[version]` with the latest release: |
18 | 9 |
|
19 | 10 | ```yaml
|
20 | 11 | dependencies:
|
21 | 12 | flutter:
|
22 | 13 | sdk: flutter
|
23 | 14 | ns_firebase_utils: ^[version]
|
24 | 15 | ```
|
25 |
| -3. click the packages get button or *flutter pub get* |
26 | 16 |
|
27 |
| -## Import the package |
| 17 | +3. Run `flutter pub get` or click the "Packages get" button in your IDE. |
| 18 | + |
| 19 | +## Importing the Package |
28 | 20 |
|
29 | 21 | ```dart
|
30 | 22 | import 'package:ns_firebase_utils/src.dart';
|
31 | 23 | ```
|
32 | 24 |
|
33 |
| -## What's in the box |
| 25 | +## What's Included |
34 | 26 |
|
35 |
| - A single plugin to add all firebase dependencies at once. |
| 27 | +This package offers a single plugin that conveniently adds all necessary Firebase dependencies to your project: |
36 | 28 |
|
37 | 29 | ```yaml
|
38 |
| - cloud_firestore: ^4.2.0 |
39 |
| - cloud_functions: ^4.0.6 |
40 |
| - fake_cloud_firestore: ^2.1.0 |
41 |
| - firebase_analytics: ^10.0.7 |
42 |
| - firebase_auth: ^4.2.1 |
43 |
| - firebase_core: ^2.4.0 |
44 |
| - firebase_crashlytics: ^3.0.7 |
45 |
| - firebase_dynamic_links: ^5.0.9 |
46 |
| - firebase_messaging: ^14.1.4 |
47 |
| - firebase_remote_config: ^3.0.7 |
48 |
| - firebase_storage: ^11.0.8 |
| 30 | + cloud_firestore: ^4.9.2 |
| 31 | + cloud_functions: ^4.4.1 |
| 32 | + fake_cloud_firestore: ^2.4.1+1 |
| 33 | + firebase_analytics: ^10.5.0 |
| 34 | + firebase_auth: ^4.10.0 |
| 35 | + firebase_core: ^2.16.0 |
| 36 | + firebase_crashlytics: ^3.3.6 |
| 37 | + firebase_dynamic_links: ^5.3.6 |
| 38 | + firebase_messaging: ^14.6.8 |
| 39 | + firebase_remote_config: ^4.2.6 |
| 40 | + firebase_storage: ^11.2.7 |
49 | 41 | ```
|
50 | 42 |
|
51 |
| - Along with awesome set of methods to help you develop faster. |
| 43 | +Additionally, it provides a powerful set of methods to accelerate your development process. |
52 | 44 |
|
| 45 | +## Thanks To All The Contributors |
53 | 46 |
|
54 |
| -## Contributing |
| 47 | +<div align="center"> |
| 48 | + <a href="https://github.com/ProjectAJ14/ns_firebase_utils/graphs/contributors"> |
| 49 | + <img src="https://contrib.rocks/image?repo=ProjectAJ14/ns_firebase_utils" /> |
| 50 | + </a> |
| 51 | +</div> |
55 | 52 |
|
| 53 | +## How to Contribute |
56 | 54 |
|
| 55 | +There are several ways to contribute to this project: |
57 | 56 |
|
58 |
| -There are couple of ways in which you can contribute. |
59 |
| -- Propose any feature, enhancement |
60 |
| -- Report a bug |
61 |
| -- Fix a bug |
62 |
| -- Participate in a discussion and help in decision making |
63 |
| -- Write and improve some **documentation**. Documentation is super critical and its importance |
64 |
| - cannot be overstated! |
65 |
| -- Send in a Pull Request :-) |
| 57 | +- Propose new features or enhancements. |
| 58 | +- Report bugs you encounter. |
| 59 | +- Contribute fixes for existing bugs. |
| 60 | +- Engage in discussions and help make important decisions. |
| 61 | +- Enhance and maintain documentation, as it plays a critical role in project success. |
| 62 | +- Submit a Pull Request to contribute your code changes. 😊 |
0 commit comments