https://github.com/canaxess/azure-immersive-reader
An Node.js Express server which handles routing and API calls to the Azure Immersive Reader.
https://github.com/canaxess/azure-immersive-reader
azure javascript jquery microsoft nodejs
Last synced: about 2 months ago
JSON representation
An Node.js Express server which handles routing and API calls to the Azure Immersive Reader.
- Host: GitHub
- URL: https://github.com/canaxess/azure-immersive-reader
- Owner: canaxess
- Created: 2020-07-19T07:40:43.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-17T10:06:41.000Z (over 4 years ago)
- Last Synced: 2025-01-03T14:52:30.192Z (over 1 year ago)
- Topics: azure, javascript, jquery, microsoft, nodejs
- Language: JavaScript
- Homepage: https://canaxess-immersive-reader.herokuapp.com/
- Size: 2.48 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Azure Immersive Reader
Immersive reader is a Microsoft Azure cognitive services tool to help a user's ability to understand content on a page. It's a single API call which displays a dialog containing the page content and a range of reading options including highlighting nouns, verbs and adjectives.
Read the article [Using Azure to help users with lower levels of literacy](https://www.canaxess.com.au/articles/using-azure-helps-users-with-lower-levels-literacy/) for more information.
Follow [these instructions](https://docs.microsoft.com/azure/cognitive-services/immersive-reader/how-to-create-immersive-reader) to create an immersive reader resource and configure Azure active directory authentication.
1. Run the provided script that will create an Immersive Reader resource and configure Azure Active Directory (Azure AD) authentication.
1. Run the `Create-ImmersiveReaderResource` powershell function using the below details:
```
Create-ImmersiveReaderResource -SubscriptionName '' -ResourceName ''
-ResourceSubdomain '' -ResourceSKU ''
-ResourceLocation '' -ResourceGroupName ''
-ResourceGroupLocation '' -AADAppDisplayName ''
-AADAppIdentifierUri '' -AADAppClientSecret ''
-AADAppClientSecretExpiration ''
```
Replacing `` with your own values.
## About
This is a Node.js Express server which handles routing and API calls to Microsoft Azure for active directory authentication and immersive reader capability. DOTENV is used to manage environment variables locally.
## Development Environment
1. run `npm i` to install all dependencies
1. Run `yarn run start` (or `nodemon start` if you want to view changes you make after doing a browser refresh)
1. Open a web browser and navigate to [http://localhost:3000](http://localhost:3000) to view the sample
## CI/CD Integration
* `git push` triggers an automatic deployment to [Heroku](https://canaxess-immersive-reader.herokuapp.com/)
## Azure AAD
The **AADAppClientSecretExpiration** token expires on `2022-06-01`.
## Heroku
The configuration variables need to set in Heroku to mirror the environment variables in the solution (not committed to repository).