Next steps:
1. Host the add-in website.
2. Sideload your add-in.
3. Build your <%= host %> Add-in using the Office JavaScript APIs.
For more information, choose Next.
You can also explore the links in the additional resources section.
You can host your add-in locally or use any web server. Make sure that the add-in is served using HTTPS and also update the add-in’s source location in the manifest.
To help you get started, we have included browser-sync for your convenience. To learn more about it, see browsersync.io.
# To host the add-in using browser-sync, use the following command:
npm start
You will need to add the self-signed security certificate that npm creates as a trusted root certificate, or your add-in will not display. You only need to do this once for all add-ins hosted this way.
# To verify that the add-in is running, open your browser and go to the main page at:
https://localhost:3000
See our documentation for information about adding the self-signed certificates.
Load the add-in into <%= host %>. The easiest way to do this is by sideloading the add-in using the in-client Office Store UI.
1. Open the Office Store, either in Outlook 2016 for Windows or Outlook on the web: - In Outlook 2016 for Windows, choose the Store button on the Home tab. - In Outlook on the web, choose the gear icon in the upper-right corner, then choose Manage integrations. 2. Click the text Click here to add a custom add-in. 3. Choose Add from file.... 4. Browse to and select the <%= projectInternalName %>-manifest.xml file from the root of the project folder, and then choose Open. 5. Review the warning prompt and choose Install. 6. Close the Office Store window. Your add-in will load in Outlook.<% } else { %> <%# Other Office apps steps go here %>
Load the add-in into <%= host %>. The easiest way to do this is by sideloading the add-in in <%= host %> Online:
1. Go to <%= host %> and create a blank document.
2. Go to Insert > Office Add-ins.
# On the My Add-ins tab (or My Organization tab if you're signed in to a work or school account),
# you'll see a link in the upper-right corner of the dialog box to Upload My add-in or Manage My Add-ins.
3. Manage My Add-ins will open a menu where you can then choose Upload My add-in.
4. Choose Browse and select the <%= projectInternalName %>-manifest.xml file from the root of the project folder, and then choose Upload.
5. Your add-in will load in <%= host %>.
If you would like to sideload your add-in into the <%= host %> desktop client, see our documentation for sideloading on Windows or sideloading on iPad and Mac.
<% } %>Here's some advice for building a stellar add-in:
- Use the Design Patterns to create a rich and immersive UI.
- Use the Office Helpers to simplify Authentication, Storage management etc.
- Use the included Office Add-in Validator to ensure your manifest.xml file is correct and complete. It will also give you information on against what platforms to test your add-in before submitting to the store.
# To validate your manifest, use the following command in your project directory:
$ npm run validate <%= projectInternalName %>-manifest.xml
- Ensure your add-in works on all browsers and platforms that Office supports.
For more information and resources to help you develop your add-in project, follow through the next steps or click on the additional resources to help you get started.