/incidents

Super simple incident report tool/page.

Primary LanguageJavaScriptMIT LicenseMIT

Incidents

Super simple incident report static page.

Demo.

Makes use of GitHub issues to query for incidents, renders GitHub issues markdown with showdown and displays the latest 30 as a list.

Configuration

At the start of the index.html file, a const config variable can be found.
This is all the configuration currently used.

const config = {
  "user": "johannestegner",
  "repo": "jitesoft/incidents",
  "baseUri": "https://api.github.com/repos",
  "pagesize": 30
};

baseUri should be left as is.
repo should be set to the <organization/user>/repository that the page will use for issues.
user should be set to the user which issues from will be displayed on the page (currently only one user is supported).
pagesize is the amount of posts to show.

Further development

This project is not beautiful, there is a lot that could be done with it, and it's totally okay to modify and use as you wish. Pull requests are greatly appreciated.

License

MIT (check LICENSE file).

Dependencies

Incidents makes use of showdown to render markdown.

Development

Currently, there is one JS file, one CSS file and one HTML file, the project can run by opening the HTML file in the browser.

Change script and style tags to include the local script and css file and work!

Minification is done with:

npx minify script.js > script.min.js
npx minify style.css > style.min.css