Skip to content

Commit

Permalink
update ExpoDemo readme
Browse files Browse the repository at this point in the history
  • Loading branch information
miquelbeltran committed Dec 9, 2024
1 parent 19833df commit 3e1c1c9
Showing 1 changed file with 16 additions and 38 deletions.
54 changes: 16 additions & 38 deletions ExpoDemo/README.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,28 @@
# Welcome to your Expo app 👋
# Raygun for Expo demo project

This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
This is an [Expo](https://expo.dev) project created following the instructions in the root `README.md` file.

## Get started
## Running the project

1. Install dependencies
1. Change the API key in `app/index.tsx`:

```tsx
const options: RaygunClientOptions = {
apiKey: "INSERT_YOUR_API_KEY_HERE",
version: "0.1.2",
enableCrashReporting: true,
logLevel: LogLevel.verbose,
};
```

2. Install dependencies

```bash
npm install
```

2. Start the app
3. Start the app

```bash
npx expo start
```

In the output, you'll find options to open the app in a

- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo

You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).

## Get a fresh project

When you're ready, run:

```bash
npm run reset-project
```

This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.

## Learn more

To learn more about developing your project with Expo, look at the following resources:

- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
- [Learn Expo tutorial](https://docs.expo.dev/tutorial/introduction/): Follow a step-by-step tutorial where you'll create a project that runs on Android, iOS, and the web.

## Join the community

Join our community of developers creating universal apps.

- [Expo on GitHub](https://github.com/expo/expo): View our open source platform and contribute.
- [Discord community](https://chat.expo.dev): Chat with Expo users and ask questions.

0 comments on commit 3e1c1c9

Please sign in to comment.