diff --git a/README.md b/README.md index 1b91027..f8c7358 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # sdp-request-watcher -## Setup +## Env and Server Setup env.example contains the setup for the env requires a Non-Browser Application key from https://api-console.zoho.com/add Place the .env file inside the src directory @@ -13,15 +13,32 @@ The technician field can have spaces after the comma however the statuses can no -## Examples -![alt text](images/image.png) +## Site Setup +Open the site after the server is running, then connect the Zoho account from the board. +1. Start the server from the `src` folder with node ./server.js +2. Open the local dashboard in your browser. Should be localhost:3000 +3. Click **Connect** to begin the Zoho authorization flow. +4. Approve the device code on the Zoho page, then return to the dashboard. + +What you should see: + +![Site setup step 1](images/1.png) + +![Site setup step 2](images/2.png) + +![Site setup step 3](images/3.png) + +![Site setup step 4](images/4.png) + +Once connected, the board will begin checking for tickets automatically and refreshing on its own based on the time set in the server.js file. ## Requirements axios dotenv -## Reference Materials + +## Reference Materials/ Provided by Skylar - [Non-Browser Apps - Overview](https://www.zoho.com/accounts/protocol/oauth/limited-input-devices.html) - [Non-Browser Apps - Initiation Request](https://www.zoho.com/accounts/protocol/oauth/devices/initiation-request.html) diff --git a/images/image.png b/images/image.png deleted file mode 100644 index 0e214a1..0000000 Binary files a/images/image.png and /dev/null differ