-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
560ed03
commit d882ca6
Showing
1 changed file
with
13 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,25 @@ | ||
| This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli). | ||
| # Raygun4ReactNative Demo App | ||
|
|
||
| # Getting Started | ||
| This folder contains the demo application for Raygun4ReactNative. | ||
|
|
||
| >**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding. | ||
| ## Setup | ||
|
|
||
| ## Step 1: Start the Metro Server | ||
| We recommend using `npx` to setup and run this demo project. | ||
|
|
||
| First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native. | ||
| Install with `npm install -g npx` if not present already in your system. | ||
|
|
||
| To start Metro, run the following command from the _root_ of your React Native project: | ||
| ### Check configuration | ||
|
|
||
| ```bash | ||
| # using npm | ||
| npm start | ||
| Verify your system setup running `npx react-native doctor` and follow the instructions. | ||
|
|
||
| # OR using Yarn | ||
| yarn start | ||
| ``` | ||
| ### Setup Raygun Options | ||
|
|
||
| ## Step 2: Start your Application | ||
| Configure the `apiKey` from the `RaygunClientOptions` in the `screens/Home.tsx` file. | ||
|
|
||
| Let Metro Bundler run in its _own_ terminal. Open a _new_ terminal from the _root_ of your React Native project. Run the following command to start your _Android_ or _iOS_ app: | ||
| ## Running | ||
|
|
||
| ### For Android | ||
| 1. Run `npx react-native start` to launch the application. | ||
| 2. Select options "run on iOS" or "run on Android". | ||
|
|
||
| ```bash | ||
| # using npm | ||
| npm run android | ||
| This command will take care of starting any necessary background processes, launch an emulator if present, and build and start the app. | ||
|
|
||
| # OR using Yarn | ||
| yarn android | ||
| ``` | ||
|
|
||
| ### For iOS | ||
|
|
||
| ```bash | ||
| # using npm | ||
| npm run ios | ||
|
|
||
| # OR using Yarn | ||
| yarn ios | ||
| ``` | ||
|
|
||
| If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ or _iOS Simulator_ shortly provided you have set up your emulator/simulator correctly. | ||
|
|
||
| This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively. | ||
|
|
||
| ## Step 3: Modifying your App | ||
|
|
||
| Now that you have successfully run the app, let's modify it. | ||
|
|
||
| 1. Open `App.tsx` in your text editor of choice and edit some lines. | ||
| 2. For **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Developer Menu** (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes! | ||
|
|
||
| For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes! | ||
|
|
||
| ## Congratulations! :tada: | ||
|
|
||
| You've successfully run and modified your React Native App. :partying_face: | ||
|
|
||
| ### Now what? | ||
|
|
||
| - If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps). | ||
| - If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started). | ||
|
|
||
| # Troubleshooting | ||
|
|
||
| If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page. | ||
|
|
||
| # Learn More | ||
|
|
||
| To learn more about React Native, take a look at the following resources: | ||
|
|
||
| - [React Native Website](https://reactnative.dev) - learn more about React Native. | ||
| - [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment. | ||
| - [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**. | ||
| - [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts. | ||
| - [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native. |