VoltBuilder: Difference between revisions

From NSB App Studio
Jump to navigation Jump to search
← Older edit
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
VoltBuilder is a replacement for PhoneGap Build. It is a service which takes the files from a web app (such as those produced by AppStudio) and turns them into a native Android and iOS app.
VoltBuilder is a service which takes the files from a web app (such as those produced by AppStudio) and turns them into a native Android and iOS app.


=== VoltBuilder compared to PhoneGap Build ===
To use it from AppStudio, you will need a VoltBuilder Plan. Use of it is included in your AppStudio subscription. [https://www.nsbasic.com/app/voltbuilder_for_appstudio.php/ More information here].
 
* Builds are made using XCode 11.3, so apps meet iTunes Connect requirements
* Signing keys are uploaded with the app and deleted as soon as the build is complete. They are not stored on the VoltBuilder site.
* Build times can be faster
* Resulting builds are smaller
* You can use the same signing keys as with PhoneGap Build
* As with PhoneGap, you do not need to install Xcode, Android Studio or anything else for it to work.
* As with PhoneGap, you can use a Windows or Mac computer.


=== How to set up VoltBuilder in AppStudio ===
=== How to set up VoltBuilder in AppStudio ===
Put your certificates in the Certificates folder (in your Project Directory)
Put your certificates in the Certificates folder (in your Project Directory)
In Project Properties, in the PhoneGap and Cordova section, fill in the following properties:
In Project Properties, in the VoltBuilder and Cordova section, fill in the following properties:


{| class="wikitable"
{| class="wikitable"
Line 19: Line 11:
! Property !! Description
! Property !! Description
|-
|-
! !! Fields required to build for Android.<br>If you leave them blank, VoltBuilder will generate the keystore automatically.
! !! Properties required to build for Android.<br>If you leave them blank, VoltBuilder will generate the keystore automatically.
|-
| androidAlias || Name of the alias in the android keystore file. Must be in certificates folder.
|-
|-
| Android Alias || Name of the alias in the android keystore file. Must be in certificates folder.
| androidAliasPassword || Password for alias in the Android keystore file.
|-
|-
| Android Alias password || Password for alias in the Android keystore file.
| androidKeystore || A .keystore file, [[Submitting_to_the_Google_Play_and_Amazon_Stores#Create_the_Keystore|generated by this procedure]]. Required for release builds. You can generate it using [https://volt.build/VoltSigner/ VoltSigner].
|-
|-
| Android Dname || Distinguished Name. User identification for creating Keystore file. Substitute your information. String format is cn=myname, ou=mygroup, o=mycompany, c=mycountry. Not required if you already have a .keystore file.
| androidKeystorePassword || Password.  
|-
|-
| Android keystore || A .keystore file, [[Submitting_to_the_Google_Play_and_Amazon_Stores#Create_the_Keystore|generated by this procedure]]. Leave blank for automatic generation by VoltBuilder.
| androidPackageType || Normally apk. For Google Play Store, set to 'bundle' to get an .aab file and set release to "release".
|-
|-
| Android keystore password || Password.  
| googlePlayKey || This is the name of the keyfile which will let VoltBuilder submit to Google, without allowing VoltBuilder to see any secure information. Go to Upload to Google Play for instructions on getting your key. (.json). See voltbuilder.json
|-
|-
! !! What kind of build should be done?
| googlePlayTrack || This is the Google Play Store track.
|-
|-
| Cordova command  ||
! !! Properties required to build for iOS
* emulate ios: Build a file for the iOS Simulator (part of XCode)
* emulate android: Build a file for the Android Emulator (part of Android Studio)
* run ios --debug: Build a development version for iOS. ''Dev p12'' and ''mobileprovision'' files required. This is the most used iOS command.
* run android --debug: Build a development version for Android.  This is the most used Android command.
* run ios --release: Build a distribution version for iOS. ''Dist p12'' and ''mobileprovision'' file required.
* run android --release: Build a release version for Android. ''Android keystore'' required.
* Create cordova directory only: Not used for VoltBuilder.
* Create and open in Xcode:  Not used for VoltBuilder.
|-
|-
| || &nbsp;
| appStoreAccount || Your Apple ID.
|-
|-
! !! Fields required to build for iOS
| appStoreAppPassword || This is an app specific password will let VoltBuilder submit to Apple, without allowing VoltBuilder to see any secure information. Go to the Apple ID page and sign in. In the Security section, click on 'Generate Password...' Use VoltBuilder as your password label. You'll get back a string like wxyz-ymul-hbqn-xxxx which you paste here.
|-
|-
| ios dev .p12 file || The p12 file is generated from the development certificate downloaded from Apple. See [[Submitting to the iOS App Store]]. You can use the same p12 for multiple apps. Leave blank if you are not building for iOS.
| iosDevP12 || The p12 file is generated from the development certificate downloaded from Apple. See [[Submitting to the iOS App Store]]. You can use the same p12 for multiple apps. Leave blank if you are not building for iOS.
|-
|-
| ios dev .p12 password || The password specified when exporting the .p12 file. Leave blank if you are not building for iOS.
| iosDevP12Password || The password specified when exporting the .p12 file. Leave blank if you are not building for iOS.
|-
|-
| ios dev mobileprovision file || The mobileprovision file is downloaded from Apple. It specifies which devices the app is allowed to run on. You need a separate mobileprovision file for each one of your apps. Leave blank if you are not building for iOS.
| iosDevelopment || The mobileprovision file is downloaded from Apple. It specifies which devices the app is allowed to run on. You need a separate mobileprovision file for each one of your apps. Leave blank if you are not building for iOS.
|-
|-
| ios dist .p12 file || The p12 file is generated from the distribution certificate downloaded from Apple. See [[Submitting to the iOS App Store]]. Leave blank if you are not building for iOS Distribution.
| iosDistP12 || The p12 file is generated from the distribution certificate downloaded from Apple. See [[Submitting to the iOS App Store]]. Leave blank if you are not building for iOS Distribution.
|-
|-
| ios dist .p12 password || The password specified when exporting the .p12 file. Leave blank if you are not building for iOS Distribution.
| iosDistP12Password || The password specified when exporting the .p12 file. Leave blank if you are not building for iOS Distribution.
|-
|-
| ios dist mobileprovision file || The mobileprovision file is downloaded from Apple. It specifies which devices the app is allowed to run on. You need a separate mobileprovision file for each one of your apps. Leave blank if you are not building for iOS Distribution.
| iosDistribution || The mobileprovision file is downloaded from Apple. It specifies which devices the app is allowed to run on. You need a separate mobileprovision file for each one of your apps. Leave blank if you are not building for iOS Distribution.
|-
|-
| ios Distribution type || This field has the following settings:
| iosPackageType || This field has the following settings:
* enterprise: Build for Enterprise Distribution. This is for apps which are used within an Enterprise only.
* enterprise: Build for Enterprise Distribution. This is for apps which are used within an Enterprise only.
* ad-hoc: Make an ad-hoc build. This will run on your local devices.
* ad-hoc: Make an ad-hoc build. This will run on your local devices.
* app-store: Make a build suitable for uploading to the iTunes Store.
* app-store: Make a build suitable for uploading to the iTunes Store.
|-
! !! Other Properties
|-
| [[BuildCounter]] || Counts the number of builds so each build has a unique versionCode
|-
| config.xml || Configuration data. [https://cordova.apache.org/docs/en/latest/config_ref/index.html See the docs].
|-
| icon (1024) || Icon template. Must be 1024x1024 png, jpg or jpeg. If not supplied, AppStudio icon will be used.
|-
| platform || What platform do you want to build for? Android, iOS or Windows.
|-
| release || What kind of build is this? debug or release.
|-
| splash (2732) || Splash screen template. Must be 2732x2732 png, jpg or jpeg. If not supplied, AppStudio splash screen will be used. File should be dragged into the top level of the Project Explorer.
|-
| splash background || Background Color of splash background (Android) as #RRGGBB
|-
| statusbarColor || Background Color of statusbar as #RRGGBB. Can not be blank.
|-
| statusbarOverlay || Should the statusbar overlay the app?
|-
| statusbarStyle || Style: default, lightcontent, blacktranslucent, blackopaque
|-
| verbose || Controls the amount of debugging in the log.
|}
|}


=== How to run VoltBuilder from AppStudio ===
=== How to run VoltBuilder from AppStudio ===
Use 'Make Native App with VoltBuilder' in the run menu. In about a minute (depending on the size of your app and the server load), you will get a link to download your app.
Use 'Make Native App with VoltBuilder' in the run menu. In about a minute (depending on the size of your app and the server load), you will get a link to download your app.

Latest revision as of 14:19, 2 December 2024

VoltBuilder is a service which takes the files from a web app (such as those produced by AppStudio) and turns them into a native Android and iOS app.

To use it from AppStudio, you will need a VoltBuilder Plan. Use of it is included in your AppStudio subscription. More information here.

How to set up VoltBuilder in AppStudio

Put your certificates in the Certificates folder (in your Project Directory) In Project Properties, in the VoltBuilder and Cordova section, fill in the following properties:

Property Description
Properties required to build for Android.
If you leave them blank, VoltBuilder will generate the keystore automatically.
androidAlias Name of the alias in the android keystore file. Must be in certificates folder.
androidAliasPassword Password for alias in the Android keystore file.
androidKeystore A .keystore file, generated by this procedure. Required for release builds. You can generate it using VoltSigner.
androidKeystorePassword Password.
androidPackageType Normally apk. For Google Play Store, set to 'bundle' to get an .aab file and set release to "release".
googlePlayKey This is the name of the keyfile which will let VoltBuilder submit to Google, without allowing VoltBuilder to see any secure information. Go to Upload to Google Play for instructions on getting your key. (.json). See voltbuilder.json
googlePlayTrack This is the Google Play Store track.
Properties required to build for iOS
appStoreAccount Your Apple ID.
appStoreAppPassword This is an app specific password will let VoltBuilder submit to Apple, without allowing VoltBuilder to see any secure information. Go to the Apple ID page and sign in. In the Security section, click on 'Generate Password...' Use VoltBuilder as your password label. You'll get back a string like wxyz-ymul-hbqn-xxxx which you paste here.
iosDevP12 The p12 file is generated from the development certificate downloaded from Apple. See Submitting to the iOS App Store. You can use the same p12 for multiple apps. Leave blank if you are not building for iOS.
iosDevP12Password The password specified when exporting the .p12 file. Leave blank if you are not building for iOS.
iosDevelopment The mobileprovision file is downloaded from Apple. It specifies which devices the app is allowed to run on. You need a separate mobileprovision file for each one of your apps. Leave blank if you are not building for iOS.
iosDistP12 The p12 file is generated from the distribution certificate downloaded from Apple. See Submitting to the iOS App Store. Leave blank if you are not building for iOS Distribution.
iosDistP12Password The password specified when exporting the .p12 file. Leave blank if you are not building for iOS Distribution.
iosDistribution The mobileprovision file is downloaded from Apple. It specifies which devices the app is allowed to run on. You need a separate mobileprovision file for each one of your apps. Leave blank if you are not building for iOS Distribution.
iosPackageType This field has the following settings:
  • enterprise: Build for Enterprise Distribution. This is for apps which are used within an Enterprise only.
  • ad-hoc: Make an ad-hoc build. This will run on your local devices.
  • app-store: Make a build suitable for uploading to the iTunes Store.
Other Properties
BuildCounter Counts the number of builds so each build has a unique versionCode
config.xml Configuration data. See the docs.
icon (1024) Icon template. Must be 1024x1024 png, jpg or jpeg. If not supplied, AppStudio icon will be used.
platform What platform do you want to build for? Android, iOS or Windows.
release What kind of build is this? debug or release.
splash (2732) Splash screen template. Must be 2732x2732 png, jpg or jpeg. If not supplied, AppStudio splash screen will be used. File should be dragged into the top level of the Project Explorer.
splash background Background Color of splash background (Android) as #RRGGBB
statusbarColor Background Color of statusbar as #RRGGBB. Can not be blank.
statusbarOverlay Should the statusbar overlay the app?
statusbarStyle Style: default, lightcontent, blacktranslucent, blackopaque
verbose Controls the amount of debugging in the log.

How to run VoltBuilder from AppStudio

Use 'Make Native App with VoltBuilder' in the run menu. In about a minute (depending on the size of your app and the server load), you will get a link to download your app.

Retrieved from "https://wiki.appstudio.dev/index.php?title=VoltBuilder&oldid=11648"