read me updates and react sample

Author: polluterofminds

example/react/README.md

@@ -1,70 +1,15 @@
-# Getting Started with Create React App
+##  Exceptionless React Example
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+This example shows how to use the `@exceptionless/react` package. There is both a class component example (App.js) and a function component example with hooks (HooksExampleApp.js). 
 
-## Available Scripts
+The package includes [error boundary support](https://reactjs.org/docs/error-boundaries.html) which means uncaught errors inside your components will automatically be sent to Exceptionless. 
 
-In the project directory, you can run:
+To run locally, follow these steps: 
 
-### `yarn start`
+1. `git clone https://github.com/exceptionless/Exceptionless.JavaScript` 
+2. `cd Exceptionless.Javascript`
+3. `npm install` 
+4. `cd example/react`
+5. `npm start` 
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
-
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `yarn build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
-
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `yarn build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+Reference the main `@exceptionless/react` [README](../../packages/react/README.md) here when building your own React app. 

example/react/src/App.css

@@ -28,6 +28,11 @@
   color: #61dafb;
 }
 
+.container {
+  max-width: 85%;
+  margin: auto;
+}
+
 @keyframes App-logo-spin {
   from {
     transform: rotate(0deg);

example/react/src/App.js

@@ -10,11 +10,14 @@ class App extends Component {
     super(props);
     this.state = {
       error: false,
+      message: "",
+      errorInfo: "",
     };
   }
   async componentDidMount() {
     await Exceptionless.startup((c) => {
-      c.apiKey = "YOUR API KEY";
+      c.apiKey = "LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw";
+      c.serverUrl = "http://localhost:5000";
       c.useDebugLogger();
 
       c.defaultTags.push("Example", "React");
@@ -25,15 +28,59 @@ class App extends Component {
     this.setState({ error: true });
   };
 
+  submitMessage = () => {
+    const message = "Hello, world!";
+    this.setState({ message: "", errorInfo: "" });
+    Exceptionless.submitLog(message);
+    this.setState({ message });
+  };
+
+  tryCatchExample = () => {
+    try {
+      this.setState({ message: "", errorInfo: "" });
+      throw new Error("Caught in the try/catch");
+    } catch (error) {
+      this.setState({ errorInfo: error.message });
+      Exceptionless.submitException(error);
+    }
+  };
+
   renderExample = () => {
     if (this.state.error) {
       throw new Error("I crashed!");
     } else {
       return (
         <div className="App">
           <header className="App-header">
-            <h1 className="App-title">Exceptionless React Sample</h1>
-            <button onClick={this.throwErrorInComponent}>Throw Error</button>
+            <div className="container">
+              <h1 className="App-title">Exceptionless React Sample</h1>
+              <p>
+                By pressing the button below, an uncaught error will be thrown
+                inside your component. This will automatically be sent to
+                Exceptionless.
+              </p>
+              <button onClick={this.throwErrorInComponent}>
+                Simulate Error
+              </button>
+              <p>
+                The following buttons simulated handled events outside the
+                component.
+              </p>
+              <button onClick={this.submitMessage}>Submit Message</button>
+              {this.state.message && (
+                <p>
+                  Message sent to Exceptionless:{" "}
+                  <code>{this.state.message}</code>
+                </p>
+              )}
+              <button onClick={this.tryCatchExample}>Try/Catch Example</button>
+              {this.state.errorInfo && (
+                <p>
+                  Error message sent to Exceptionless:{" "}
+                  <code>{this.state.errorInfo}</code>
+                </p>
+              )}
+            </div>
           </header>
         </div>
       );

example/react/src/HooksExampleApp.js

@@ -0,0 +1,73 @@
+import React, { useEffect, useState } from "react";
+import "./App.css";
+import {
+  Exceptionless,
+  ExceptionlessErrorBoundary,
+} from "@exceptionless/react";
+
+const HooksExampleApp = () => {
+  const [error, setError] = useState(false);
+  useEffect(() => {
+    startExceptionless();
+  }, []);
+
+  const startExceptionless = async () => {
+    await Exceptionless.startup((c) => {
+      c.apiKey = "LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw";
+      c.serverUrl = "http://localhost:5000";
+      c.useDebugLogger();
+
+      c.defaultTags.push("Example", "React");
+    });
+  };
+
+  const throwErrorInComponent = () => {
+    setError(true);
+  };
+
+  const submitMessage = () => {
+    Exceptionless.submitLog("Hello, world!");
+  };
+
+  const tryCatchExample = () => {
+    try {
+      throw new Error("Caught in the try/catch");
+    } catch (error) {
+      Exceptionless.submitException(error);
+    }
+  };
+
+  const renderExample = () => {
+    if (error) {
+      throw new Error("I crashed!");
+    } else {
+      return (
+        <div className="App">
+          <header className="App-header">
+            <div className="container">
+              <h1 className="App-title">Exceptionless React Sample</h1>
+              <p>
+                By pressing the button below, an uncaught error will be thrown
+                inside your component. This will automatically be sent to
+                Exceptionless.
+              </p>
+              <button onClick={throwErrorInComponent}>Simulate Error</button>
+              <p>
+                The following buttons simulated handled events outside the
+                component.
+              </p>
+              <button onClick={submitMessage}>Submit Message</button>
+              <button onClick={tryCatchExample}>Try/Catch Example</button>
+            </div>
+          </header>
+        </div>
+      );
+    }
+  };
+
+  return (
+    <ExceptionlessErrorBoundary>{renderExample()}</ExceptionlessErrorBoundary>
+  );
+};
+
+export default HooksExampleApp;

packages/browser/README.md

@@ -0,0 +1,47 @@
+## Exceptionless Browser
+
+This package provides native JavaScript support for applications that are built in vanilla HTML and JS. 
+
+### Installation  
+
+**Package Managers** 
+
+`npm install @exceptionless/browser`
+
+or
+
+`yarn add @exceptionless/browser`  
+
+
+### Configuration 
+
+```js
+await Exceptionless.startup(c => {
+  c.useDebugLogger();
+  c.services.log = new TextAreaLogger("logs", c.services.log);
+
+  c.apiKey = "LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw";
+  c.serverUrl = "http://localhost:5000";
+  c.updateSettingsWhenIdleInterval = 15000;
+  c.usePersistedQueueStorage = true;
+  c.setUserIdentity("12345678", "Blake");
+  c.useSessions();
+
+  // set some default data
+  c.defaultData["SampleUser"] = {
+    id: 1,
+    name: "Blake",
+    password: "123456",
+    passwordResetToken: "a reset token",
+    myPasswordValue: "123456",
+    myPassword: "123456",
+    customValue: "Password",
+    value: {
+      Password: "123456"
+    }
+  };
+
+  c.defaultTags.push("Example", "JavaScript");
+  c.settings["@@error:MediaError"] = "Off"
+});
+```

packages/react/README.md

@@ -0,0 +1,70 @@
+## Exceptionless React
+
+The Exceptionless React package provides a native way to handle errors and events in React. This means errors inside your components, which tend to crash your entire app, can be sent to Exceptionless and you can be alerted. Additionally, you can use this package to catch errors throughout your non-component functions such as in Redux actions, utility functions, etc. 
+
+### Getting Started 
+
+To use this package, your must be using ES6 and Node 15+. 
+
+**Install** 
+
+NPM: 
+
+`npm install @exceptionless/react` 
+
+Yarn: 
+
+`yarn add @exceptionless/react` 
+
+### Configuration 
+
+Inside your `index.js` file or your `App.js` file, you can configure and start Exceptionless as follows.
+
+**Class Components**
+
+```jsx
+class App extends Component {
+  async componentDidMount() {
+    await Exceptionless.startup((c) => {
+      c.apiKey = "LhhP1C9gijpSKCslHHCvwdSIz298twx271n1l6xw"; //Replace with your API key
+      c.serverUrl = "http://localhost:5000"; //Remove if using the hosted version of Exceptionless
+    });
+  }
+
+  render() {
+    return (
+      <ExceptionlessErrorBoundary>
+        <div>
+          // YOUR APP COMPONENTS HERE
+        </div>
+      </ExceptionlessErrorBoundary>
+    );
+  }
+}
+
+export default App;
+```
+
+### Handling Events 
+
+While errors within the components themselves are automatically sent to Exceptionless, you will still want to handle events that happen outside the components. 
+
+Because the Exceptionless client is a singleton, it is available anywhere in your app where you import it. Here's an example from a file we'll call `utilities.js`.
+
+```js
+export const myUtilityFunction = () => {
+  try {
+    //  Handle successful run of code
+  } catch(e) {
+    //  If there's an error, send it to Exceptionless
+    Exceptionless.submitException(e);
+  }
+}
+```
+
+You can also sent events and logs that are not errors by simply calling the built-in methods on the Exceptionless class: 
+
+```js
+Exceptionless.submitLog("Hello, world!");
+Exceptionless.submitFeatureUsage("New Shopping Cart Feature");
+```