npm create tamagui
This monorepo is a starter for an Expo + Next.js + Tamagui + Solito app.
Many thanks to @FernandoTheRojo for the Solito starter monorepo which this was forked from. Check out his talk about using expo + next together at Next.js Conf 2021.
The main apps are:
-
expo
(native) -
next
(web) -
packages
shared packages across appsui
includes your custom UI kit that will be optimized by Tamaguiapp
you'll be importing most files fromapp/
features
(don't use ascreens
folder. organize by feature.)provider
(all the providers that wrap the app, and some no-ops for Web.)
You can add other folders inside of packages/
if you know what you're doing and have a good reason to.
Tip
Switching from app
to pages
router:
- remove
app
folder fromapps/next
- move
index.tsx
frompages-example
topages
folder - rename
pages-example-user
touser
and be sure to updatelinkTarget
inscreen.tsx
touser
as well - delete
SwitchRouterButton.tsx
component and remove it fromscreen.tsx
andpackages/ui/src/index.tsx
- search for
pagesMode
keyword and remove it
-
Install dependencies:
yarn
-
Next.js local dev:
yarn web
To run with optimizer on in dev mode (just for testing, it's faster to leave it off): yarn web:extract
. To build for production yarn web:prod
.
To see debug output to verify the compiler, add // debug
as a comment to the top of any file.
- Expo local dev:
yarn native
Note we're following the design systems guide and creating our own package for components.
See packages/ui
named @my/ui
for how this works.
If you're installing a JavaScript-only dependency that will be used across platforms, install it in packages/app
:
cd packages/app
yarn add date-fns
cd ../..
yarn
If you're installing a library with any native code, you must install it in expo
:
cd apps/expo
yarn add react-native-reanimated
cd ..
yarn
yarn upgrade-interactive
You can also install the native library inside of packages/app
if you want to get autoimport for that package inside of the app
folder. However, you need to be careful and install the exact same version in both packages. If the versions mismatch at all, you'll potentially get terrible bugs. This is a classic monorepo issue. I use lerna-update-wizard
to help with this (you don't need to use Lerna to use that lib).
You may potentially want to have the native module transpiled for the next app. If you get error messages with Cannot use import statement outside a module
, you may need to use transpilePackages
in your next.config.js
and add the module to the array there.
- Root:
apps/next
- Install command to be
yarn set version stable && yarn install
- Build command: leave default setting
- Output dir: leave default setting