Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robinnaumann/moewe_dart
https://github.com/robinnaumann/moewe_dart
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/robinnaumann/moewe_dart
- Owner: RobinNaumann
- License: mit-0
- Created: 2024-04-09T13:41:08.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-12-02T14:52:01.000Z (23 days ago)
- Last Synced: 2024-12-18T04:59:46.670Z (7 days ago)
- Language: Dart
- Size: 417 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# **mœwe** | dart client
moewe _(german for seagull 🐣)_ is a open source, privacy preserving crash logging service that can be self-hosted.
## motivation
During foss development, I always wished there was a simple platform for crash reporting and knowing roughly how many people are using the software. mœwe aims to be exactly this without the privacy concerns of the large analytics solutions. I hope this is useful to you.
_yours, Robin_
find more information at [moewe.app](https://moewe.app)
## features
- crash logging
- event logging
- user feedback collection
- live config via feature flags
- includes simple UI components for simple integration
- let users know about new app versions
## usage
initialize the client within your Flutter applications `main.dart`
```dart
void main() async {
// setup Moewe for crash logging
await Moewe(
host: "open.moewe.app",
project: "yourProjectId",
app: "yourAppId"
).init();
runApp(const MyApp());
}
```
That's it 🎉
you can now use the `moewe` client within your app:
```dart
moewe.events.appOpen();
moewe.log.debug("this is a debug message");
moewe.crash("an error occurred", null);
// report user feedback
MoeweFeedbackPage.show(...) // use package UI
moewe.feedback(...); // manually
// get flag value from server
moewe.config.flagString("fav_food");
// other UI components:
MoeweUpdateView
moeweUpdateWrapper(...)
```
### crash logging
global crash logging is automatically enabled.
You can manually log crashes using:
1. the `moewe.crash(...)` function.
2. wrapping (possibly async) content with
`moewe.crashLogged(() async {...})`.