From d1c709ce19dfc1f477822ebdadf6734b399525d0 Mon Sep 17 00:00:00 2001 From: Max Lynch Date: Tue, 19 Jan 2021 14:03:54 -0600 Subject: [PATCH] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 155899a..b74d002 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,12 @@ npx cap open ios npx cap open android ``` +## Caveats + +One caveat with this project: Because the app must be able to run purely client-side and use [Next.js's Export command](https://nextjs.org/docs/advanced-features/static-html-export), that means no Server Side Rendering in this code base. There is likely a way to SSR and a fully static Next.js app in tandem but it requires [a Babel plugin](https://github.com/erzr/next-babel-conditional-ssg-ssr) or would involve a more elaborate monorepo setup with code sharing that is out of scope for this project. + +Additionally, Next.js routing is not really used much in this app beyond a catch-all route to render the native app shell and engage the Ionic React Router. This is primarily because Next.js routing is not set up to enable native-style transitions and history state management like the kind Ionic uses. + ## What is Capacitor? You can think of [Capacitor](https://capacitorjs.com/) as a sort of "electron for mobile" that runs standard web apps on iOS, Android, Desktop, and Web.