Skip to content

Commit

Permalink
## [1.1.1+1] - Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ProjectAJ14 committed Dec 20, 2022
1 parent d7fe922 commit f1e133d
Show file tree
Hide file tree
Showing 5 changed files with 51 additions and 21 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
## [1.1.1+1] - Updated README.md

## [1.1.1] - Updated plugins
- FirebaseOptions are optional

Expand Down
41 changes: 21 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

🦾 Set of methods/extensions for firebase that makes using framework in a much easier and clean way also adds additional functionality.

###Contributors
<br>
<div align="center" >
<a href="https://github.com/ProjectAJ14/ns_firebase_utils/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ProjectAJ14/ns_firebase_utils" />
</a>
</div>
<br>

## Let's get started

1. Go to `pubspec.yaml`
Expand All @@ -26,33 +35,25 @@ import 'package:ns_firebase_utils/src.dart';
A single plugin to add all firebase dependencies at once.

```yaml
firebase_core: ^1.19.2
firebase_auth: ^3.4.2
firebase_storage: ^10.3.2
cloud_firestore: ^3.3.0
cloud_functions: ^3.3.2
firestore_ui: ^1.23.0
firebase_analytics: ^9.2.0
firebase_crashlytics: ^2.8.5
firebase_dynamic_links: ^4.3.2
firebase_remote_config: ^2.0.12
firebase_messaging: ^12.0.0
fake_cloud_firestore: ^1.2.4
cloud_firestore: ^4.2.0
cloud_functions: ^4.0.6
fake_cloud_firestore: ^2.1.0
firebase_analytics: ^10.0.7
firebase_auth: ^4.2.1
firebase_core: ^2.4.0
firebase_crashlytics: ^3.0.7
firebase_dynamic_links: ^5.0.9
firebase_messaging: ^14.1.4
firebase_remote_config: ^3.0.7
firebase_storage: ^11.0.8
```

Along with awesome set of methods to help you develop faster.


## Contributing

<br>
<div align="center" >
<p>Thanks to all contributors of this package</p>
<a href="https://github.com/ProjectAJ14/ns_firebase_utils/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ProjectAJ14/ns_firebase_utils" />
</a>
</div>
<br>


There are couple of ways in which you can contribute.
- Propose any feature, enhancement
Expand Down
20 changes: 20 additions & 0 deletions example/main.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import 'package:flutter/cupertino.dart';
import 'package:ns_firebase_utils/src.dart';

void main() async {
await NSFirebase.instance.init(
printLogs: true,
buildNumber: '1.0.0',
version: '1.0.0',
);
runApp(MyApp());
}

class MyApp extends StatelessWidget {
const MyApp({Key? key}) : super(key: key);

@override
Widget build(BuildContext context) {
return const Placeholder();
}
}
7 changes: 7 additions & 0 deletions lib/src.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,16 @@ library ns_firebase_utils;
import 'package:firebase_core/firebase_core.dart';
import 'package:ns_firebase_utils/analytics/analytics_service.dart';

/// AppAnalytics service
final AppAnalytics analytics = new AppAnalytics();

typedef LogCallBack = void Function(
Object object, [
Object detail,
]);

/// Error Log callback
///
typedef ErrorLogCallBack = void Function(
Object object, [
dynamic error,
Expand All @@ -26,6 +29,9 @@ void _errorLogs(Object message, [dynamic error, StackTrace? stackTrace]) {}
LogCallBack appLogsNS = _appLogs;
ErrorLogCallBack errorLogsNS = _errorLogs;

/// NSFirebase class
/// This class is used to initialize firebase
///
class NSFirebase {
bool _isInitialized = false;
String _buildNumber = '';
Expand Down Expand Up @@ -65,6 +71,7 @@ class NSFirebase {
}
}

/// Initialize default firebase app
Future<void> initializeDefault({
FirebaseOptions? options,
String? name,
Expand Down
2 changes: 1 addition & 1 deletion pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: ns_firebase_utils
description: Set of methods/extentions for firebase that makes using framework in a much easier and clean way also adds additional functionality
version: 1.1.1
version: 1.1.1+1
homepage: https://github.com/ajaynonstopio/ns_firebase_utils

environment:
Expand Down

0 comments on commit f1e133d

Please sign in to comment.