Skip to content

Commit

Permalink
Update Reproducer README.md file.
Browse files Browse the repository at this point in the history
  • Loading branch information
cortinico authored Oct 7, 2024
1 parent eae81e5 commit 069b706
Showing 1 changed file with 72 additions and 6 deletions.
78 changes: 72 additions & 6 deletions .github/template-cleanup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,76 @@

This is your new React Native Reproducer project.

## Reproducer todo list
# Reproducer TODO list

- [x] Create a new reproducer project.
- [ ] Git clone your repository locally.
- [ ] Edit the project to reproduce the failure you're seeing.
- [ ] Push your changes, so that Github Actions can run the CI.
- [ ] Make sure the repository is public and share the link with the issue you reported.
- [x] 1. Create a new reproducer project.
- [ ] 2. Git clone your repository locally.
- [ ] 3. Edit the project to reproduce the failure you're seeing.
- [ ] 4. Push your changes, so that Github Actions can run the CI.
- [ ] 5. Make sure the repository is public and share the link with the issue you reported.

# How to use this Reproducer

This project has been created with `npx @react-native-community/cli init` and is a vanilla React Native app.

> [!IMPORTANT]
> Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/set-up-your-environment) so that you have a working environment locally.
## Step 1: Start the Metro Server

First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.

To start Metro, run the following command from the _root_ of your React Native project:

```bash
# using npm
npm start

# OR using Yarn
yarn start
```

## Step 2: Start your Application

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:

### For Android

```bash
# using npm
npm run android

# OR using Yarn
yarn android
```

### For iOS

First, make sure you install dependencies with:

```bash
cd ios && bundle install && bundle exec pod install
```

Then you can run the iOS app with:

```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!

0 comments on commit 069b706

Please sign in to comment.