https://github.com/jitesoft/incidents

Super simple incident report tool/page.
https://github.com/jitesoft/incidents

github-issues html incident incident-response-tooling status-page

Last synced: 5 days ago
JSON representation

Super simple incident report tool/page.

• Host: GitHub
• URL: https://github.com/jitesoft/incidents
• Owner: jitesoft
• License: mit
• Created: 2023-01-26T12:25:29.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-08T13:41:55.000Z (11 months ago)
• Last Synced: 2024-05-03T04:47:44.767Z (7 months ago)
• Topics: github-issues, html, incident, incident-response-tooling, status-page
• Language: JavaScript
• Homepage: https://jitesoft.github.io/incidents
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Incidents

Super simple incident report static page.

[Demo](https://jitesoft.github.io/incidents/).

Makes use of GitHub issues to query for incidents, renders GitHub issues markdown

with [showdown](https://github.com/showdownjs/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.

```javascript

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 /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](LICENSE) file).

## Dependencies

Incidents makes use of [showdown](https://github.com/showdownjs/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:

```shell

npx minify script.js > script.min.js

npx minify style.css > style.min.css

```