From f472c2f636f2ee8277271281ae09f20da272f8e7 Mon Sep 17 00:00:00 2001 From: Craig Oda Date: Fri, 31 May 2024 14:23:11 -1000 Subject: [PATCH] added github information --- docs/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index 79b085d..7fd955d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,10 +13,10 @@ In addition, it is recommended you get a username and password for the partner technical documentation. ## Installation and Setup - -1. Install Node.js : https://nodejs.org/en - Note that Oppkey uses [nvm](https://github.com/nvm-sh/nvm) to manage node versions. However, it may be simpler for you to install node straight from the node site. -2. In the root directory of the project, run `npm install` -3. create a `secrets.env` file in the project root. The file has this format: +1. clone down repo [oppkey-ricoh-viewer-demo-basic](https://github.com/codetricity/oppkey-ricoh-viewer-demo-basic) (recommended) or [oppkey-ricoh360-viewer-demo-with-login](https://github.com/codetricity/oppkey-ricoh360-viewer-demo-with-login) (for cloud deploy with basic password auth) +1. Install [Node.js](https://nodejs.org/en) - Note that Oppkey uses [nvm](https://github.com/nvm-sh/nvm) to manage node versions. However, it may be simpler for you to install node straight from the node site. +1. In the root directory of the project, run `npm install` +1. create a `secrets.env` file in the project root. The file has this format: ```text CLIENT_ID= @@ -25,7 +25,7 @@ PRIVATE_KEY="" ``` Full `secrets.env` used by Oppkey is available [here](https://github.com/codetricity/oppkey-ricoh-viewer-credentials/blob/main/README.md). The -private key, client id, and client secret are in a private GitHub repo. If you are a RICOH staff or partner and have authorization to use the Oppkey client id, private key, and client secret, then contact Oppkey and we will send you the file. Otherwise, you will need to use your own keys that you received from RICOH. +private key, client id, and client secret are in a private GitHub repo. If you are a RICOH staff or partner and have authorization to use the Oppkey client id, private key, and client secret, then contact Oppkey and we will send you the file. Otherwise, please use your own credentials you received from RICOH. ## Start Server