{"id":13609871,"url":"https://github.com/haroldadmin/WhatTheStack","last_synced_at":"2025-04-12T22:32:05.046Z","repository":{"id":41496534,"uuid":"235653322","full_name":"haroldadmin/WhatTheStack","owner":"haroldadmin","description":"See a pretty error screen when your Android app crashes","archived":false,"fork":false,"pushed_at":"2023-03-06T09:14:46.000Z","size":2353,"stargazers_count":247,"open_issues_count":8,"forks_count":22,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T16:19:58.513Z","etag":null,"topics":["android","android-library","debugging","tooling"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haroldadmin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-22T19:48:29.000Z","updated_at":"2024-12-05T10:23:35.000Z","dependencies_parsed_at":"2024-08-01T19:43:41.624Z","dependency_job_id":"d0a71cf7-1f3f-4ab2-9dec-9f8e2a0aedab","html_url":"https://github.com/haroldadmin/WhatTheStack","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haroldadmin%2FWhatTheStack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haroldadmin%2FWhatTheStack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haroldadmin%2FWhatTheStack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haroldadmin%2FWhatTheStack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haroldadmin","download_url":"https://codeload.github.com/haroldadmin/WhatTheStack/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248640817,"owners_count":21138099,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","android-library","debugging","tooling"],"created_at":"2024-08-01T19:01:38.820Z","updated_at":"2025-04-12T22:32:05.014Z","avatar_url":"https://github.com/haroldadmin.png","language":"Kotlin","funding_links":[],"categories":["Kotlin"],"sub_categories":[],"readme":"# WhatTheStack\n\n![Banner](media/repo-banner.png)\n\nWhatTheStack is a library to make your debugging experience on Android better.\n\nIt shows you a pretty error screen when your Android App crashes, instead of a boring old dialog saying \"Unfortunately, \\\u003cyour-app\\\u003e has crashed\".\n\n![Demo](media/demo.gif)\n\n## Setup\n\n[![Release](https://jitpack.io/v/haroldadmin/WhatTheStack.svg)](https://jitpack.io/#haroldadmin/WhatTheStack)\n\nAdd Jitpack repository in your root `build.gradle` file:\n\n```groovy\nallprojects {\n  repositories {\n    maven { url 'https://jitpack.io' }\n  }\n}\n```\n\nAnd then add the dependency to your app:\n\n```groovy\ndependencies {\n  debugImplementation 'com.github.haroldadmin:WhatTheStack:(latest-version)'\n}\n```\n\nNow when an uncaught exception is thrown in your application, you will be greeted with a screen containing information about the crash. We support light and dark themes too!\n\n\u003cimg src=\"media/screenshot-dark.png\" width=\"360px\" height=\"640px\"/\u003e\n\u003cimg src=\"media/screenshot-light.png\" width=\"360px\" height=\"640px\"/\u003e\n\n## Usage\n\nWhatTheStack works by overriding the default exception handler in your app. It processes any uncaught exception in your app, parses it to extract useful information, and then shows it in a pretty screen.\n\n### Automatic Initialization\n\nWhatTheStack uses the [Jetpack App Startup](https://developer.android.com/topic/libraries/app-startup) library to run automatically when your app starts. You don't need to write any code to initialize it manually.\n\n\u003cdetails\u003e\n  \u003csummary\u003eNeed to disable automatic initialization?\u003c/summary\u003e\n  If you want to disable automatic startup, add the following lines to your Manifest file:\n\n  ```xml\n  \u003cprovider\n    android:name=\"androidx.startup.InitializationProvider\"\n    android:authorities=\"${applicationId}.androidx-startup\"\n    android:exported=\"false\"\n    tools:node=\"merge\"\u003e\n    \u003cmeta-data  android:name=\"com.haroldadmin.whatthestack.WhatTheStackInitializer\"\n      android:value=\"androidx.startup\"\n        tools:node=\"remove\"/\u003e\n  \u003c/provider\u003e\n  ```\n\u003c/details\u003e\n\n### Debug vs Release builds\n\nWe recommend using `WhatTheStack` in debug builds only. We see it as a tool to improve the experience of the developer, not the user.\n\n\u003cdetails\u003e\n\u003csummary\u003eNeed to use it in release builds?\u003c/summary\u003e\nIf you want to use WhatTheStack in release builds, replace the `debugImplementation` dependency with `implementation'.\n\n```diff\ndependencies {\n-  debugImplementation 'com.github.haroldadmin:WhatTheStack:(latest-version)'\n+  implementation 'com.github.haroldadmin:WhatTheStack:(latest-version)'\n}'\n```\n\nThe library ships with Proguard rules to ensure that it works correctly even after minification.\n\u003c/details\u003e\n\n### Multi-Process Service\n\n`WhatTheStack` runs a bound service in a separate process to show you the error screen on a crash.\n\nWe need to run this code in a separate process because you can't reliably launch new Activities\nin the host application's process after an uncaught exception is thrown.\n\n\n\n## Contributions\n\nWe are happy to accept any external contributions in the form of PRs, issues, or blog posts. \n\nPlease consider starring the repository if you find it useful or intriguing!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharoldadmin%2FWhatTheStack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fharoldadmin%2FWhatTheStack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fharoldadmin%2FWhatTheStack/lists"}