Merge pull request #5 from KasselLabs/usage

Add instructions on how to build and run ios and android apps
2021-01-19 13:50:22 -06:00
parent 4a8f711a65 c6622aff75
commit 86714475d3
1 changed files with 23 additions and 0 deletions
@@ -8,6 +8,29 @@ This repo is a starting point for building an iOS, Android, and Progressive Web

 Next.js handles the production React app experience, Tailwind can be used to style each page of your app, Ionic Framework provides the cross-platform system controls (navigation/transitions/tabs/etc.), and then Capacitor bundles all of it up and runs it on iOS, Android, and Web with full native access.

+## Usage
+
+Build your client side Next.js files
+
+```bash
+npm run build
+npm run export
+```
+
+All the client side files will be sent to `./out/` directory, you can now run capacitor on iOS or Android:
+
+```bash
+# iOS
+npx cap copy ios
+npx cap open ios
+```
+
+```bash
+# Android
+npx cap copy android
+npx cap open android
+```
+
 ## 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.