https://github.com/bugsplat-git/my-electron-crasher

⚡️🌩🔋 Sample Electron TypeScript application integrated with BugSplat for crash and error reporting
https://github.com/bugsplat-git/my-electron-crasher

bugsplat crash crashpad electron error javascript reporting typescript

Last synced: over 1 year ago
JSON representation

⚡️🌩🔋 Sample Electron TypeScript application integrated with BugSplat for crash and error reporting

• Host: GitHub
• URL: https://github.com/bugsplat-git/my-electron-crasher
• Owner: BugSplat-Git
• License: cc0-1.0
• Created: 2021-07-03T15:05:13.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2025-02-01T13:04:56.000Z (over 1 year ago)
• Last Synced: 2025-02-02T11:32:38.259Z (over 1 year ago)
• Topics: bugsplat, crash, crashpad, electron, error, javascript, reporting, typescript
• Language: TypeScript
• Homepage: https://docs.bugsplat.com/introduction/getting-started/integrations/cross-platform/electron
• Size: 1.88 MB
• Stars: 8
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
[![bugsplat-github-banner-basic-outline](https://user-images.githubusercontent.com/20464226/149019306-3186103c-5315-4dad-a499-4fd1df408475.png)](https://bugsplat.com)




# 
BugSplat
 

### **
Crash and error reporting built for busy developers.
**



    

        

    

    

        

    



# my-electron-crasher

The my-electron-crasher sample demonstrates how to use how to use Electron's [Crashpad](https://chromium.googlesource.com/crashpad/crashpad/+/refs/heads/main/doc/overview_design.md) based [crashReporter](https://github.com/electron/electron/blob/master/docs/api/crash-reporter.md) for tracking native crashes with BugSplat. This sample also demonstrates BugSplat's [npm package](https://www.npmjs.com/package/bugsplat-node) to track JavaScript/TypeScript errors in your Electron application.



## 🥾 Steps

1. `git clone https://github.com/BugSplat-Git/my-electron-crasher`

2. `cd my-electron-crasher && npm i`

3. `npm start` which will run the build and upload source maps via [@bugsplat/symbol-upload](https://www.npmjs.com/package/@bugsplat/symbol-upload)

4. Click any of the buttons in the app to test the BugSplat integration

5. Navigate to BugSplat's [Crashes](https://app.bugsplat.com/v2/crashes) page in your web browser

6. When prompted to log in, use the username `fred@bugsplat.com` and password `Flintstone`

7. Click the ID of your crash to see crash details. If everything worked, you should see something that resembles the following



For more information about getting started with Electron, check out the [Quick Start Guide](http://electron.atom.io/docs/tutorial/quick-start) within the Electron documentation. For additional help using BugSplat, check out the [documentation](https://www.bugsplat.com/docs/sdk/electron/) on our website or email support(at)bugsplat.com if you have any questions.

### Native Addon

If you would like to test a crash in a Native Addon, follow the steps to configure your system for [cmake-js](https://github.com/cmake-js/cmake-js#installation) and set the `prestart` script to `npm run build:all`.

Good luck!

© BugSplat Software

[Web](https://www.bugsplat.com) | [Twitter](https://twitter.com/BugSplatCo) | [Facebook](https://www.facebook.com/bugsplatsoftware/)