Step-by-Step Guide to Creating an Expo Monorepo with Nx
This blog will show you how to create an Expo monorepo with Nx. In this example, you will be creating two Expo apps in a monorepo with @nx/expo: one shows random facts about cats, and the other shows random facts about dogs.
As shown in the above screenshots, these two apps have the same branding and reuse all components.
This blog will go through:
- How to create a monorepo workspace with Nx
- How to share a React Native library
- How to build an Expo app
- How to submit an Expo app to the app store
Github repo: https://github.com/xiongemi/nx-expo-monorepo
Creating an Nx Workspace
To create a new Nx workspace, run the command npx create-nx-workspace <workspace name> in the terminal. In this example, let’s name it nx-expo-monorepo:
✔ Where would you like to create your workspace? · create-nx-monorepo
✔ Which stack do you want to use? · react
✔ What framework would you like to use? · expo
✔ Application name · cats
✔ Enable distributed caching to make your CI faster · NoThis will create an integrated repo. What is an integrated repo?
An integrated repo contains projects that depend on each other through standard import statements. There is typically a single version of every dependency defined at the root.
https://nx.dev/concepts/integrated-vs-package-based#integrated-repos
Now, your Nx workspace should have cats and cats-e2e under the apps folder and an empty libs folder:
Existing Nx Workspace
If you already have an Nx workspace, you need to install the @nx/expo package:
# npm
npm install @nx/expo --save-dev
# yarn
yarn add @nx/expo --dev
# pnpm
pnpm add @nx/expo --save-devTo create an Expo app, run:
npx nx generate @nx/expo:app catsAlternatively, if you use Visual Studio Code as your code editor, you can also create apps using Nx Console:
Install Tech Stacks
Here are the tech stacks this example is going to use:
- Material design library: react-native-paper
# npm
npm install react-native-paper react-native-safe-area-context --save
# yarn
yarn add react-native-paper react-native-safe-area-context
# pnpm
pnpm add react-native-paper react-native-safe-area-context --save- Routing: @react-navigation/native
# npm
npm install react-native-paper react-native-screens @react-navigation/native-stack --save
# yarn
yarn add react-native-paper react-native-screens @react-navigation/native-stack
# pnpm
pnpm add react-native-paper react-native-screens @react-navigation/native-stack --saveCreate a Shareable UI Library
With all the required libraries installed, you need to create a sharable UI library:
npx nx generate @nx/expo:lib uiNow under the libs folder, a ui folder has been created:
To create a component in the ui library, run:
npx nx generate @nx/expo:component carousel --project=ui --exportYou can see that a carousel folder has been created in the libs/ui/src/lib folder:
Next, modify this component to display the content with props passed in:
Now you can use this component in your app directly using an import:
import { Carousel } from '@nx-expo-monorepo/ui';Add Navigation
This project is going to use the stack navigator from @react-navigation/native. So the app needs to import from @react-navigation/stack. In apps/cats/src/app/App.tsx, you can change the UI to have one screen displaying a carousel with mock data:
Run the app withnx start cats, and you should be able to see the app on the simulator:
Add Another App
In this example, there is already a Cats app. To create the Dogs app, run the command:
npx nx generate @nx/expo:app dogsAlternatively, if you use Visual Studio Code as your code editor, you can also create apps using Nx Console:
Under the apps folder, there should be cats/, dogs/ and their e2es.
You can reuse the UI library in the Dogs app in apps/dogs/src/app/App.tsx with the below code:
Build Expo Apps
EAS Build is a hosted service for building app binaries for your Expo and React Native projects. To set up EAS locally:
1. Install EAS CLI
EAS CLI is the command-line app to interact with EAS services in the terminal. To install it, run the command:
npm install -g eas-cli2. Login To EAS
If you are not logged in, run the command:
eas login3. Build the Apps
After the EAS setup, you can build apps by running the command:
npx nx build cats
npx nx build dogsThere are different options you can specify with the build command. For example, you can specify the platform you want to build:
npx nx build cats --platform=all
npx nx build cats --platform=android
npx nx build cats --platform=iosAlternatively, if you want to create a build to run on a simulator/emulator, you can run:
npx nx build cats --profile=previewYou can view your build status at https://expo.dev/:
If you want to create a build locally using your own infrastructure:
npx nx build cats --localHere is the complete list of flags for the build command: https://nx.dev/packages/expo/executors/build.
Submit to the App Store
Before you submit, you need to have paid developer accounts for iOS and Android.
- iOS: You need to create an Apple Developer account on the Apple Developer Portal.
- Android: You need to create a Google Play Developer account on the Google Play Console sign-up page. You also need to manually create an app on Google Play Console and upload your app for the first time.
1. Run the production build
To submit to the app store, you can build the app by running:
npx nx build cats --profile=production2. Submit the Build
You can manually upload the build bundle binary to the app store, or you can submit it through EAS.
First, in app.json under the project apps/cats/app.json, you need to make sureios.bundleIdentifier and android.package keys are correct:
To submit your app to the app stores, run:
npx nx submit catsNx will prompt you to choose the platform to which you want to submit:
Or you can also specify the platform directly in the initial command:
npx nx submit cats --platform=all
npx nx submit cats --platform=android
npx nx submit cats --platform=iosIt will then ask you to choose which binary to submit from one of the following options:
- The latest finished Android build for the project on EAS servers.
- Specific build ID. It can be found on the builds dashboard.
- Path to an .apk or .aab or .ipa archive on your local filesystem.
- URL to the app archive.
Alternatively, you can submit your app on the expo.dev site. Go to your build, under options, choose “Submit to an app store”:
Summary
In this article, you have learned how to:
- Create multiple apps in a monorepo using @nx/expo
- Create a shared library
- Build your app using EAS
- Submit your app to the App Store
With Nx, it is easy to create and scale up an Expo app. Even though this app is currently a simple 2-page app, you can easily scale it up with more libraries and components. Furthermore, you can also reuse those libraries in the future if you decide to add another app to the repo.
