WEBXR NEST API

A REST API for the R&P WebXR application

Built With

• NEST.JS
• TypeScript

Prerequisites

• Azure account
• Azure storage account to create storage blobs
• The lastest version of Node.js

Installation

1. Inside your Azure storage account

   • Navigate to Settings, select Access keys
   • Find the Connection String value under key1
   • Copy the value, later it will be added to your environment variable

2. Clone this repo

   git clone https://github.com/sara-sabr/WebXR-API.git

3. Install the NPM packages

   npm install

4. Create a .env file and add the following contents:

   # Port number
   PORT=3000
   
   # JWT KEY (change it)
   JWT_KEY=somesecretyouchoose
   
   # Account creds to API (change it)
   AUTH_USER=someuser
   AUTH_PASS=somepwd
   
   # Set this to true if using Azure App Service HTTPS offload
   IS_AZURE=false
   
   # Azure Cognitive Services credentials (change it)
   COGNITIVE_SERVICES_KEY=somekey
   COGNITIVE_SERVICES_REGION=someregion
   
   # Chatbot URL
   CHATBOT_URL=URL goes here ...
   CHATBOT_ORG=organization id
   CHATBOT_CAT=category
   

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Usage

This application is created for the purpose of using API endpoints for Azure storage containers and blobs.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

License

Nest is MIT licensed. "# WebXR-Nest_API"