mirror of
https://github.com/movie-web/native-app.git
synced 2025-09-13 10:03:26 +00:00
refactor to turbo
This commit is contained in:
Jorrin
159
README.md
159
README.md
@@ -1,70 +1,139 @@
|
||||
# movie-web native-app
|
||||
|
||||
Native-app for movie-web.
|
||||
## About
|
||||
|
||||
## Getting started
|
||||
It uses [Turborepo](https://turborepo.org) and contains:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
|
||||
// Having nx installed globally is recommended
|
||||
pnpm install -g nx
|
||||
|
||||
// If you don't want nx installed globally, you can use the following command
|
||||
(pnpm exec or npx) nx <command>
|
||||
```text
|
||||
.github
|
||||
└─ workflows
|
||||
└─ CI with pnpm cache setup
|
||||
.vscode
|
||||
└─ Recommended extensions and settings for VSCode users
|
||||
apps
|
||||
└─ expo
|
||||
├─ Expo SDK 50
|
||||
├─ React Native using React 18
|
||||
├─ Navigation using Expo Router
|
||||
├─ Tailwind using Nativewind
|
||||
└─ Typesafe API calls using tRPC
|
||||
packages
|
||||
├─ tmdb
|
||||
└─ Typesafe API calls to The Movie Database
|
||||
tooling
|
||||
├─ eslint
|
||||
| └─ shared, fine-grained, eslint presets
|
||||
├─ prettier
|
||||
| └─ shared prettier configuration
|
||||
├─ tailwind
|
||||
| └─ shared tailwind configuration
|
||||
└─ typescript
|
||||
└─ shared tsconfig you can extend from
|
||||
```
|
||||
|
||||
## Running tasks
|
||||
### Configure Expo `dev`-script
|
||||
|
||||
To execute tasks with Nx use the following syntax:
|
||||
#### Use iOS Simulator
|
||||
|
||||
```bash
|
||||
nx <target> <project> <...options>
|
||||
```
|
||||
1. Make sure you have XCode and XCommand Line Tools installed [as shown on expo docs](https://docs.expo.dev/workflow/ios-simulator).
|
||||
|
||||
For example, to run the mobile app:
|
||||
> **NOTE:** If you just installed XCode, or if you have updated it, you need to open the simulator manually once. Run `npx expo start` in the root dir, and then enter `I` to launch Expo Go. After the manual launch, you can run `pnpm dev` in the root directory.
|
||||
|
||||
### Android
|
||||
```diff
|
||||
+ "dev": "expo start --ios",
|
||||
```
|
||||
|
||||
```bash
|
||||
nx run mobile:android
|
||||
```
|
||||
2. Run `pnpm dev` at the project root folder.
|
||||
|
||||
### iOS
|
||||
#### Use Android Emulator
|
||||
|
||||
```bash
|
||||
nx run mobile:ios
|
||||
```
|
||||
1. Install Android Studio tools [as shown on expo docs](https://docs.expo.dev/workflow/android-studio-emulator).
|
||||
|
||||
## Building archives
|
||||
2. Change the `dev` script at `apps/expo/package.json` to open the Android emulator.
|
||||
|
||||
### Android .apk
|
||||
```diff
|
||||
+ "dev": "expo start --android",
|
||||
```
|
||||
|
||||
```bash
|
||||
nx run mobile:prebuild --platform=android
|
||||
cd apps/mobile/android && ./gradlew assembleRelease
|
||||
```
|
||||
3. Run `pnpm dev` at the project root folder.
|
||||
|
||||
### iOS .app
|
||||
> **TIP:** It might be easier to run each app in separate terminal windows so you get the logs from each app separately. This is also required if you want your terminals to be interactive, e.g. to access the Expo QR code. You can run `pnpm --filter expo dev` and `pnpm --filter nextjs dev` to run each app in a separate terminal window.
|
||||
|
||||
#### Real device
|
||||
### 3. When it's time to add a new package
|
||||
|
||||
```bash
|
||||
nx run mobile:prebuild --platform=ios
|
||||
cd apps/mobile/ios && xcodebuild archive -workspace movieweb.xcworkspace -scheme "movieweb" -sdk iphoneos -configuration "Release" -archivePath "build/app.xcarchive" -destination generic/platform=iOS CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO
|
||||
```
|
||||
To add a new package, simply run `pnpm turbo gen init` in the monorepo root. This will prompt you for a package name as well as if you want to install any dependencies to the new package (of course you can also do this yourself later).
|
||||
|
||||
#### Simulator
|
||||
The generator sets up the `package.json`, `tsconfig.json` and a `index.ts`, as well as configures all the necessary configurations for tooling around your package such as formatting, linting and typechecking. When the package is created, you're ready to go build out the package.
|
||||
|
||||
```bash
|
||||
nx run mobile:prebuild --platform=ios
|
||||
cd apps/mobile/ios && xcodebuild archive -workspace movieweb.xcworkspace -scheme "movieweb" -sdk iphonesimulator -configuration "Release" -archivePath "build/app.xcarchive" -destination "generic/platform=iOS Simulator" CODE_SIGN_IDENTITY="" CODE_SIGNING_REQUIRED=NO CODE_SIGNING_ALLOWED=NO
|
||||
```
|
||||
## Deployment
|
||||
|
||||
## Repository information
|
||||
### Expo
|
||||
|
||||
This project uses Nx to manage the monorepo. For more information about Nx, visit [nx.dev](https://nx.dev).
|
||||
Deploying your Expo application works slightly differently compared to Next.js on the web. Instead of "deploying" your app online, you need to submit production builds of your app to app stores, like [Apple App Store](https://www.apple.com/app-store) and [Google Play](https://play.google.com/store/apps). You can read the full [guide to distributing your app](https://docs.expo.dev/distribution/introduction), including best practices, in the Expo docs.
|
||||
|
||||
1. Make sure to modify the `getBaseUrl` function to point to your backend's production URL:
|
||||
|
||||
<https://github.com/t3-oss/create-t3-turbo/blob/656965aff7db271e5e080242c4a3ce4dad5d25f8/apps/expo/src/utils/api.tsx#L20-L37>
|
||||
|
||||
2. Let's start by setting up [EAS Build](https://docs.expo.dev/build/introduction), which is short for Expo Application Services. The build service helps you create builds of your app, without requiring a full native development setup. The commands below are a summary of [Creating your first build](https://docs.expo.dev/build/setup).
|
||||
|
||||
```bash
|
||||
# Install the EAS CLI
|
||||
pnpm add -g eas-cli
|
||||
|
||||
# Log in with your Expo account
|
||||
eas login
|
||||
|
||||
# Configure your Expo app
|
||||
cd apps/expo
|
||||
eas build:configure
|
||||
```
|
||||
|
||||
3. After the initial setup, you can create your first build. You can build for Android and iOS platforms and use different [`eas.json` build profiles](https://docs.expo.dev/build-reference/eas-json) to create production builds or development, or test builds. Let's make a production build for iOS.
|
||||
|
||||
```bash
|
||||
eas build --platform ios --profile production
|
||||
```
|
||||
|
||||
> If you don't specify the `--profile` flag, EAS uses the `production` profile by default.
|
||||
|
||||
4. Now that you have your first production build, you can submit this to the stores. [EAS Submit](https://docs.expo.dev/submit/introduction) can help you send the build to the stores.
|
||||
|
||||
```bash
|
||||
eas submit --platform ios --latest
|
||||
```
|
||||
|
||||
> You can also combine build and submit in a single command, using `eas build ... --auto-submit`.
|
||||
|
||||
5. Before you can get your app in the hands of your users, you'll have to provide additional information to the app stores. This includes screenshots, app information, privacy policies, etc. _While still in preview_, [EAS Metadata](https://docs.expo.dev/eas/metadata) can help you with most of this information.
|
||||
|
||||
6. Once everything is approved, your users can finally enjoy your app. Let's say you spotted a small typo; you'll have to create a new build, submit it to the stores, and wait for approval before you can resolve this issue. In these cases, you can use EAS Update to quickly send a small bugfix to your users without going through this long process. Let's start by setting up EAS Update.
|
||||
|
||||
The steps below summarize the [Getting started with EAS Update](https://docs.expo.dev/eas-update/getting-started/#configure-your-project) guide.
|
||||
|
||||
```bash
|
||||
# Add the `expo-updates` library to your Expo app
|
||||
cd apps/expo
|
||||
pnpm expo install expo-updates
|
||||
|
||||
# Configure EAS Update
|
||||
eas update:configure
|
||||
```
|
||||
|
||||
7. Before we can send out updates to your app, you have to create a new build and submit it to the app stores. For every change that includes native APIs, you have to rebuild the app and submit the update to the app stores. See steps 2 and 3.
|
||||
|
||||
8. Now that everything is ready for updates, let's create a new update for `production` builds. With the `--auto` flag, EAS Update uses your current git branch name and commit message for this update. See [How EAS Update works](https://docs.expo.dev/eas-update/how-eas-update-works/#publishing-an-update) for more information.
|
||||
|
||||
```bash
|
||||
cd apps/expo
|
||||
eas update --auto
|
||||
```
|
||||
|
||||
> Your OTA (Over The Air) updates must always follow the app store's rules. You can't change your app's primary functionality without getting app store approval. But this is a fast way to update your app for minor changes and bug fixes.
|
||||
|
||||
9. Done! Now that you have created your production build, submitted it to the stores, and installed EAS Update, you are ready for anything!
|
||||
|
||||
### References
|
||||
This app is based on [create-t3-turbo](https://github.com/t3-oss/create-t3-turbo) and [Turborepo](https://turborepo.org).
|
||||
|
||||
### Mobile app
|
||||
|
||||
The mobile app is built with React Native and Expo. For more information about Expo, visit [expo.io](https://expo.io).
|
||||
|
||||
Reference in New Issue
Block a user