Skip to content
This repository was archived by the owner on Mar 15, 2025. It is now read-only.

beta -> production #1041

Merged
merged 1 commit into from
Dec 15, 2023
Merged

beta -> production #1041

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,12 @@ Note: the installation of Node JS add paths to your operating system's PATH vari

From the root of the repo:

0. On Node 20: `set NODE_OPTIONS=--openssl-legacy-provider`
1. `npm install` **Be sure to run this after every pull/merge!**
2. `npm run start`
1. `npm run start`

An SSL certificate for localhost along with the CA certificate and key will be written to ~/.office-addin-dev-certs (%USERPROFILE%\.office-addin-dev-certs on Windows).
Please accept the prompt or dialog that appears if the CA certificate needs to be installed.

Your default browser will launch almost immediately. However, note that **it will take some 30-60 seconds before the website is actually up and running.**

Expand Down Expand Up @@ -56,18 +60,6 @@ Warning: Cannot update during an existing state transition (such as within `rend

You can safely ignore these -- those won't show up to users on the production site.

## Bypassing localhost HTTPS security issues

For testing in the web browser (whether standalone or in Office Online) in Chrome, you can bypass the "insecure localhost" by enabling this setting: <chrome://flags/#allow-insecure-localhost>

For testing on a PC version of Office, you _could_ trust the certificates from within Internet Explorer. However, new certs get generated every time that you run `npm run start`, so trusting them over and over again is tedious. If you're only interested in making changes to code that runs inside the taskpanes (which is what you will be doing 99% of the time for any Editor/Runner changes, unless you're debugging something to do with "functions.html" and the other ribbon buttons), you can just click through the "This site is not secure" warning and choose "Go on to the website (not recommended)" option.

![Proceed through "This site is not secure"](.github/images/site-not-secure.png).

If you _do_ need to trust the certificates, see below for a step-by-step animation. But be aware that you'll keep having to repeat these steps... The sites you'd need to trust are <https://localhost:3000> (editor) and <https://localhost:3200> (runner).

![Trust SLL instructions](.github/images/trust-ssl-internet-explorer.gif).

## Testing inside of an add-in

The **easiest** option is to install the **Store** version of the add-in (get it from <https://aka.ms/getscriptlab>). Then, using the dropdown on bottom left when in the Settings mode, switch to alpha -- and **from alpha, to localhost**. Note that the localhost option will only show up if you're in alpha (or already on localhost). The steps are akin to what's [described in the README](README.md#2017) for switching to Script Lab 2017, except choosing "Alpha" and then "localhost:3000" instead.
Expand Down
Loading