- Removed entire apps/desktop directory with Tauri desktop support - Updated README.md to focus on Android development only - Removed iOS-specific instructions and references - Streamlined getting started guide with dependency installation step 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
84 lines
2.9 KiB
Markdown
84 lines
2.9 KiB
Markdown
This is a new [**React Native**](https://reactnative.dev) project, bootstrapped using [`@react-native-community/cli`](https://github.com/react-native-community/cli).
|
||
|
||
# Getting Started
|
||
|
||
> **Note**: Make sure you have completed the [Set Up Your Environment](https://reactnative.dev/docs/set-up-your-environment) guide before proceeding.
|
||
|
||
## Step 1: Install Dependencies
|
||
|
||
First, install the required dependencies:
|
||
|
||
```sh
|
||
# Using npm
|
||
npm install
|
||
|
||
# OR using Yarn
|
||
yarn install
|
||
```
|
||
|
||
## Step 2: Start Metro
|
||
|
||
You will need to run **Metro**, the JavaScript build tool for React Native.
|
||
|
||
To start the Metro dev server, run the following command from the root of your React Native project:
|
||
|
||
```sh
|
||
# Using npm
|
||
npm start
|
||
|
||
# OR using Yarn
|
||
yarn start
|
||
```
|
||
|
||
## Step 3: Build and run your app
|
||
|
||
With Metro running, open a new terminal window/pane from the root of your React Native project, and use the following command to build and run your Android app:
|
||
|
||
### Android
|
||
|
||
```sh
|
||
# Using npm
|
||
npm run android
|
||
|
||
# OR using Yarn
|
||
yarn android
|
||
```
|
||
|
||
> **Note**: This project is configured for Android development only.
|
||
|
||
If everything is set up correctly, you should see your new app running in the Android Emulator or your connected Android device.
|
||
|
||
You can also build it directly from Android Studio.
|
||
|
||
## Step 4: Modify your app
|
||
|
||
Now that you have successfully run the app, let's make changes!
|
||
|
||
Open `App.tsx` in your text editor of choice and make some changes. When you save, your app will automatically update and reflect these changes — this is powered by [Fast Refresh](https://reactnative.dev/docs/fast-refresh).
|
||
|
||
When you want to forcefully reload, for example to reset the state of your app, you can perform a full reload:
|
||
|
||
- **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Dev Menu**, accessed via <kbd>Ctrl</kbd> + <kbd>M</kbd> (Windows/Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (macOS).
|
||
|
||
## Congratulations! :tada:
|
||
|
||
You've successfully run and modified your React Native App. :partying_face:
|
||
|
||
### Now what?
|
||
|
||
- If you're curious to learn more about React Native, check out the [docs](https://reactnative.dev/docs/getting-started).
|
||
|
||
# Troubleshooting
|
||
|
||
If you're having issues getting the above steps 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.
|