Skip to content

Kontent-ai-Learn/kontent-ai-learn-notifier

Repository files navigation

master develop

Kontent.ai Learn - Notifier

Backend service for Kontent.ai Learn.

Service is responsible for notifying defined Microsoft Teams channels.

Overview

  1. This project is a TypeScript Azure Functions application.
  2. It receives an HTTP request with body consisting of mode (one of error/success), activityTitle and text.
  3. After receiving a request, the service pushes notification to the defined Microsoft Teams channels.

Setup

Prerequisites

  1. Node (+yarn) installed
  2. Visual Studio Code installed
  3. Subscriptions on MS Azure and Kontent.ai

Instructions

  1. Open Visual Studio Code and install the prerequisites according to the following steps.
  2. Log in to Azure using the Azure Functions extension tab.
  3. Clone the project repository and open it in Visual Studio Code.
  4. Run yarn install in the terminal.
  5. Set the required keys.
  6. Deploy to Azure using Azure Functions extension tab, or run locally by pressing Ctrl + F5 in Visual Studio Code.

Required Keys

  • Teams.NotificationUrls - Urls of Microsoft Teams channels connected by semicolon.

Testing

  • Run yarn run test in the terminal.

How To Contribute

Feel free to open a new issue where you describe your proposed changes, or even create a new pull request from your branch with proposed changes.

License

All the source codes are published under MIT license.