yttringar

This repo contains the code for the front end of the yttringar service. It is a widget built on Github issues to create trackable feedback for specific (documentation) pages. It is used internally at Skandinaviska Enskilda Banken (SEB), one of Sweden's major banks, to provide feedback for developer specific information. The concept is heavily inspired by the feedback system on docs.microsoft.com, for example.

It is a fork from https://github.com/utterance/utterances.

How it works

When Yttringar loads, the GitHub issue search API is used to find the issue associated with the page based on url, pathname or title.

To create new issues, users must authorize the yttringar app to post on their behalf using the GitHub OAuth flow.

Develop locally

Config

First make sure you create a file in src called config.ts. In src/config.ts insert the following strings:

export const settings = {
  YTTRINGAR_API: the oauth api for producing github tokens.
  GITHUB_API: github's REST-api, if running externally use https://api.github.com/
  GITHUB_REPO_URL: The url for the repo where the user should be linked to. TODO: take this value from front end instantiation
}

Run locally

npm run dev

Build for production

npm run build
npm run start

or just use the Dockerfile present

Disclaimer

This is a work in progress and lots of the functionality from utterances has been omitted for the time being Contributions are welcome!