html2app Template

Getting Started

# download the template
npx gitget https://github.com/yandeu/html2app-template my-app

# change directory into the template
cd my-app

# build the app (bundle javascript files)
npm run build

# now zip all files
(linux/macos) zip -r app.zip assets www config.json
(windows) tar.exe -acvf app.zip www assets config.json

# upload app.zip to https://html2app.dev/

config.json

{
  "name": "App Name", // 12 character max including spaces
  "version": "1.0.0", // version in the format [Major].[Minor].[Patch] (string)
  "build": 1, // build in the format [Build] (should be a positive integer)
  "id": "com.example.appname", // Must be in Java package form with no dashes (ex: com.example.app)
  "fullscreen": false, // true | false
  "orientation": "default", // "portrait" | "landscape" | "default"
  "plugins": [], // (see below)
  // optional add your build credentials:
  "credentials": {
    "ios": {
      "ad-hoc": {
        "name": "NAME",
        "secret": "SECRET"
      },
      "store": {
        "name": "NAME",
        "secret": "SECRET"
      }
    },
    "android": {
      "release": {
        "name": "NAME",
        "secret": "SECRET"
      }
    }
  },
  // enable mixed content for the Android WebView (This is not intended for use in production)
  "allowMixedContent": false
}

plugins[]

• For now you can only add plugins from the scope @capacitor/ and @capacitor-community/.
• For now you can only add plugins that do not require updating native code.
  Example:
  • @capacitor/dialog will work.
  • @capacitor/filesystem will NOT work,
    since it requires modifying AndroidManifest.xml.

www/

The www/ folder needs at least a index.html file.

assets/

assets/
├── icon-background.png   432x432
├── icon-foreground.png   432x432
├── icon.png              1024x1024
└── splash.png            2732x2732