Skip to content

Commit 324b597

Browse files
authored
add README for mobile
add README for mobile
1 parent ef7131c commit 324b597

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

shatter-mobile/README.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,50 @@
1-
# Welcome to your Expo app 👋
1+
# Introduction
22

3-
This is an [Expo](https://expo.dev) project created with [`create-expo-app`](https://www.npmjs.com/package/create-expo-app).
3+
Our mobile uses: React Native + Expo
44

5-
## Get started
5+
# How to run
66

7-
1. Install dependencies
8-
9-
```bash
10-
npm install
11-
```
12-
13-
2. Start the app
14-
15-
```bash
16-
npx expo start
17-
```
18-
19-
In the output, you'll find options to open the app in a
20-
21-
- [development build](https://docs.expo.dev/develop/development-builds/introduction/)
22-
- [Android emulator](https://docs.expo.dev/workflow/android-studio-emulator/)
23-
- [iOS simulator](https://docs.expo.dev/workflow/ios-simulator/)
24-
- [Expo Go](https://expo.dev/go), a limited sandbox for trying out app development with Expo
25-
26-
You can start developing by editing the files inside the **app** directory. This project uses [file-based routing](https://docs.expo.dev/router/introduction).
7+
- Step 1: Clone the repo
8+
9+
- Step 2: Enter to `shatter-mobile` dir by running the command in the terminal
10+
```
11+
cd shatter-mobile
12+
```
13+
- Step 3: Install the dependencies and libraries by running
14+
```
15+
npm i
16+
```
17+
- Step 4: Run the mobile app locally
18+
```
19+
npx expo start
20+
```
21+
- Step 5: After running the above command, you will see list of options
22+
```
23+
› Press a │ open Android
24+
› Press i │ open iOS simulator
25+
› Press w │ open web
26+
```
27+
### 1. WINDOW
2728

28-
## Get a fresh project
29+
- If you are using Window -> before pressing `a`, make sure you already installed **Android Studio**.
2930

30-
When you're ready, run:
31+
- If NOT, follow this guide: https://docs.expo.dev/get-started/set-up-your-environment/?platform=android&device=simulated
3132

32-
```bash
33-
npm run reset-project
34-
```
33+
### 2. MACOS
3534

36-
This command will move the starter code to the **app-example** directory and create a blank **app** directory where you can start developing.
35+
- If you are using Mac -> before pressing `i`, make sure you already installed **XCode**.
3736

38-
## Learn more
37+
- If NOT, follow this guide: https://docs.expo.dev/get-started/set-up-your-environment/?platform=ios&device=simulated
3938

40-
To learn more about developing your project with Expo, look at the following resources:
39+
### 3. Use your own phone
4140

42-
- [Expo documentation](https://docs.expo.dev/): Learn fundamentals, or go into advanced topics with our [guides](https://docs.expo.dev/guides).
43-
- [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.
41+
- Download the "Expo Go" app in AppStore or CHPlay
4442

45-
## Join the community
43+
- Then scan the QR code in the terminal. It will navigate you to sse our project in this app
44+
45+
- Don't need to press any button in the terminal
4646

47-
Join our community of developers creating universal apps.
47+
# Note
48+
- Because you are working on mobile, you are expected to run backend locally to test, check the guide `shatter-backend/README.md`
49+
- Don't push changes directly to main, create your own branch and pull request to merge
4850

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

0 commit comments

Comments
 (0)