Forge - Cross-browser Add-on Development Tools - Read the Docs

189 Pages·2014·2.55 MB·English

Forge - Cross-browser Add-on
Development Tools
Release 1.4
Forge
July28,2014

Contents
1 Quickstart 1
2 Features 3
2.1 Mobile-seeall... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2 Nativeplugins-learnmore... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.3 Browseradd-ons-seeall... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
i
ii
1
CHAPTER
Quickstart
Getstarted
Step1: Signup
Step2: InstalltheTriggerToolkit
Step3: Readourtutorialsandcreateapps
1
Forge-Cross-browserAdd-onDevelopmentTools,Release1.4
2 Chapter1. Quickstart
2
CHAPTER
Features
2.1 Mobile - see all...
• Addressbook
• Analytics
• Barcode/QRscanning
• Camera
• Childbrowser
• Cross-domainajax
• CustomURLschemes
• Events
• FacebookSDKaccess
• Files
• Geolocation
• In-apppayments
• Media
• NativeUIenhancements
• Offline
• Pushnotifications
• Reload
• SMS
• Storage
• TopbarnativeUI
• TabbarnativeUI
2.2 Native plugins - learn more...
2.3 Browser add-ons - see all...
• Backgroundpage
• Contentscripts
• Cross-domainajax
• Messaging
• Storage
• Toolbarbutton
3
Forge-Cross-browserAdd-onDevelopmentTools,Release1.4
2.3.1 Get Started
Setupyourenvironment
StartbyreadingGettingStartedwithForgetosetupyourenvironmenttointeractwithourcloudbuildservice.
Then,dependingonwhichplatformsyou’replanningtotarget,tobuilda‘HelloWorld’app,you’llwanttocover:
• ForgeandMobile
• ForgeandtheWeb
• ForgeandBrowserAdd-ons
Runthroughatutorial
We have tutorials for mobile and browser add-ons. If you run into trouble understanding how to use the provided
ForgeAPIs,readaboutUsingAPImethods
• Tutorial: creatingaweatherapp
• Tutorial: creatingabrowseradd-onwhichinteractswithpages
RefertorelevantrecipesandAPImodules
CheckoutthefulllistofourAPIModulesformobile,webandbrowseradd-ons.
Usingourowndemoappsandlearningsfromourmobilecustomersoverthepast6months,we’vecompiledalistof
recipesandbestpracticeswhichmayhelpyougetstartedwithbuildingyourownapp.
GettingStartedwithForge
TouseForge,youwillfirstneedtoinstallthetoolkitfrom: https://trigger.io/forge/toolkit
Aftercompletingtheinstallprocess,startthetoolkitandyouwillbepromptedtocreateanaccount. Youcanusethe
toolkitUItobuildandtestyourappsoryoucanusethecommand-linetoolsthatarebundledwiththetoolkit.
ReadontogetstartedwiththetoolkitorlearnaboutGettingstartedwiththecommand-linetools
Gettingstartedwiththetoolkit Readtheinstructionsonthetoolkitdownloadpagetolearnhowtoinstallandstart
thetoolkitonyourplatform.
Aftersigninguporloggingin,youwillseeyourYourApps.Youcanalwaysreturntothisscreenbyclicking“Manage
Apps”intheheader. Atfirstnoappswillbelistedhere.
4 Chapter2. Features
Forge-Cross-browserAdd-onDevelopmentTools,Release1.4
Creatingyourfirstapp Clickthe“Create”linkatthebottom-lefttocreateanewapp. Youwillbepromptedfora
nameandlocationandthenyouwillbereturnedtoYourAppswhereyouwillnowseethenewapplisted.
Congratulations,you’vecreatedyourfirstappandarereadytobuildandtestit.
Workingwithanexistingapp Ifyouhaveanexistingapp, forexampleyoumayhavecloneditfromanexisting
Githubreposorcreateditwiththecommand-linetools,thenyouwillneedtoimportit.
Simply click the “Import” link at the bottom-right of Your Apps. You will be prompted for the location and then
returnedtoYourAppswhereyouwillnowseetheapplistedreadytobebuiltandtested.
Whatnext? Bynow,youhaveadevelopmentenvironmentsetup.
Fromhere,youcouldtakealookat:
• ForgeandMobile
• ForgeandtheWeb
• ForgeandBrowserAdd-ons
• Tutorial: creatingaweatherapp
Getting started with the command-line tools To run forge commands use the forge executable in your Toolkit
installation.
Note: Itisrecommendedthatyouaddthedirectorythattheforgeexecutableisintoyourpath, otherwiseyouwill
havetousethefullpathtotheforgeexecutableeachtimeyouwanttorunanyforgecommand.
Windows
C:\> ‘‘C:\Users\<Your Username>\AppData\Local\Trigger Toolkit\forge.exe’’ create
2.3. Browseradd-ons-seeall... 5
Forge-Cross-browserAdd-onDevelopmentTools,Release1.4
Macusers
$ $HOME/Library/Trigger\ Toolkit/forge create
Linuxusers
$ ~/TriggerToolkit/forge create
Creatingyourfirstapp
Note: Ifyouhaveanexistingappyou’dliketoworkwith,seeWorkingwithanexistingapp.
To keep each of your apps separate, we expect that you will want to work on them in different directories. In the
terminal,we’llcreateanewdirectoryandmoveintoit:
mkdir "../demo-app"
cd "../demo-app"
Now,we’llcreateourapp,withtheforge createcommand:
$ forge create
[ INFO] Forge tools running at version 1
Enter app name:
Atthispointadescriptivenameforyournewapp: ifyou’replanningonfollowingalongwithourtutorial,“Weather
Demo”wouldbeareasonablechoice.
If this is the first time you’re running this command, you will be prompted to log in with the email address and
passwordthatyousignedupwithattheForgewebsite:
$ forge create
[ INFO] Forge tools running at version 2.3.1
Enter app name: Weather Demo
Your email address: [email protected]
Password:
[ INFO] authenticating as "[email protected]"
[ INFO] authentication successful
[ INFO] fetching initial project template
Atthispoint,you’rereadytoedityourappandstartrunningbuilds!
Workingwithanexistingapp Ifyouarealreadyworkingwithanapponyourmachine,simplychangedirectory
towheretheappis:
cd "../my-existing-app"
Inthatdirectory,youshouldhaveasrcdirectory,containingthecodeforyourapp.
Whatnext? Bynow,youhaveadevelopmentenvironmentsetup.
Fromhere,youcouldtakealookat:
• ForgeandMobile
• ForgeandtheWeb
• ForgeandBrowserAdd-ons
• Tutorial: creatingaweatherapp
6 Chapter2. Features