Skip to content

add: documentation to help Windows developers to use openssl #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 14, 2022
Merged

add: documentation to help Windows developers to use openssl #168

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1357fd8
add: documentation to help Windows developers to use openssl
smrghsh Jul 6, 2022
4c6ed54
fix: change starting position to test appears in front of user during VR
smrghsh Jul 11, 2022
a49098e
Revert "fix: change starting position to test appears in front of use…
smrghsh Jul 14, 2022
636e9be
Update contributor-docs/README.md
stalgiag Jul 14, 2022
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
6 changes: 4 additions & 2 deletions contributor-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ We know the development process can be a little tricky at first. You're not alon

If you're continuously changing files in the library, you may want to run `npm run watch` to automatically rebuild the library for you whenever any of its source files change without you having to first type the command manually.

6. WebXR requires HTTPS. You can run a local test environment by running `npm run setup-ssl` and answering the questions. You can enter whatever you want for the values. Now when you run `npm run dev-server` you will get an HTTPS local server. Note that you will still get the 'Your connection is not private' warning. You can click through this by selecting advanced and "Proceed to ... (unsafe)". Alternatively, you can type 'thisisunsafe' or generate the certificate locally using mkcert. [See the top answer here for more info](https://stackoverflow.com/questions/7580508/getting-chrome-to-accept-self-signed-localhost-certificate).
6. WebXR requires HTTPS. You can run a local test environment by running `npm run setup-ssl` and answering the questions. You can enter whatever you want for the values. Now when you run `npm run dev-server` you will get an HTTPS local server. Note that you will still get the 'Your connection is not private' warning. You can click through this by selecting advanced and "Proceed to ... (unsafe)". Alternatively, you can type 'thisisunsafe' or generate the certificate locally using mkcert. [See the top answer here for more info](https://stackoverflow.com/questions/7580508/getting-chrome-to-accept-self-signed-localhost-certificate).
Note: Windows users may get the following error: `'openssl' is not recognized as an internal or external command,` One solution is to use the Git Bash terminal included with Git installations instead of Powershell or Command Prompt.

7. If you made changes to source code, look at the relevant manual test examples to see that everything still works as expected. We are hoping to automate this with more unit tests in the future.

Expand All @@ -84,4 +85,5 @@ With **VR devices** that connect to your computer through SteamVR (Vive, Index,

With Meta Quest, the Quest Browser should be used.

With Android Mobile for sketches made for both **AR and VR**, you can run `npm run generate:keys` on your development computer to create an SSL cert-key pair. Then you can run `http-server -S -C cert.pem` to start a secure local server. This should result in a message that gives you the IP address for your new secure local server (ex: `192.168.1.104:8080`). You can then add that IP into the URL input in the Chrome browser on your phone and access the p5xr folder from your phone. This allows you to run the `manual-test-examples` on your phone.
With Android Mobile for sketches made for both **AR and VR**, you can run `npm run generate:keys` on your development computer to create an SSL cert-key pair. Then you can run `http-server -S -C cert.pem` to start a secure local server. This should result in a message that gives you the IP address for your new secure local server (ex: `192.168.1.104:8080`). You can then add that IP into the URL input in the Chrome browser on your phone and access the p5xr folder from your phone. This allows you to run the `manual-test-examples` on your phone.