Skip to content

Commit 21fbaad

Browse files
committed
Add README file
1 parent cef3922 commit 21fbaad

File tree

1 file changed

+74
-0
lines changed
  • packages/expo-template-redux-typescript

1 file changed

+74
-0
lines changed
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Expo Template Redux TypeScript
2+
3+
The official Redux+TS template for Expo.
4+
5+
## :arrow_forward: Usage
6+
7+
```sh
8+
npx create-expo my-app --template expo-template-redux-typescript
9+
```
10+
11+
# Getting Started
12+
13+
> **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.
14+
15+
## Step 1: Start the Metro Server
16+
17+
First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
18+
19+
To start Metro, run the following command from the _root_ of your React Native project:
20+
21+
```bash
22+
# using npm
23+
npm start
24+
```
25+
26+
```bash
27+
# OR using Yarn
28+
yarn start
29+
```
30+
31+
## Step 2: Start your Application
32+
33+
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:
34+
35+
### For Android
36+
37+
```bash
38+
# using npm
39+
npm run android
40+
```
41+
42+
```bash
43+
# OR using Yarn
44+
yarn android
45+
```
46+
47+
### For iOS
48+
49+
```bash
50+
# using npm
51+
npm run ios
52+
```
53+
54+
```bash
55+
# OR using Yarn
56+
yarn ios
57+
```
58+
59+
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.
60+
61+
This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.
62+
63+
## Step 3: Modifying your App
64+
65+
Now that you have successfully run the app, let's modify it.
66+
67+
1. Open `App.tsx` in your text editor of choice and edit some lines.
68+
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!
69+
70+
For **iOS**: Hit <kbd>Cmd ⌘</kbd> + <kbd>R</kbd> in your iOS Simulator to reload the app and see your changes!
71+
72+
## Congratulations! :tada:
73+
74+
You've successfully run and modified your Expo App. :partying_face:

0 commit comments

Comments
 (0)