tadhglewis / issue-status

A flexible, modern and blazingly fast ☄️ status page

Overhaul in progress! You can still use version 1.1.2 or alternatively view all previously tagged releases

issue-status

A flexible, modern and blazingly fast ☄️ status page

Features

💗 System health

📝 Incident history, scheduled maintenance and postmortems

⌨️ Pre-built templates

🌓 Dark mode (theming)

🛜 Hosted on GitHub Pages and more

✍️ Markdown support

🔴 Live updates

Demo

View demo now!

This demo is hosted on GitHub Pages and using the GitHub provider.

Templates

Pre-built incident templates are included to quickly provide updates on an incident. These templates are available when creating a GitHub Issue.

You may modify templates to suit your needs.

Providers

The data fetching layer is separated into so called Providers. This allows you to swap out the underlying data source that powers the frontend.

Currently, only the following providers are supported:

• GitHub - uses the GitHub API and GitHub Issues as a source.
• Static - a testing provider with static data.

Contributions: If you have created a custom provider which may have value to others, please feel free to reach out to discuss including it in this project.

Theming

Currently, there are two available themes which will automatically be applied based on the users system preferences:

• light
• dark

Theming tokens are available for editing in the themes file.

issue-status's Issues

Improve Components

Possible improvements

• Add tooltip to components (this can pull the body of the component issue)
• Make components linkable (will need to find somewhere to pull a url from)
• Make component groups (ie website and inside the website group you have CDN, API, etc)

Still deciding on whether above improvements should be done.

If you are interested in this GitHub Issue leave a comment so I can put this as priority.

Improve main status bar logic

The main status bar logic is as follows: < 70% Components operational = "Some systems are experiencing issues", more than 0 Components major outage = "Some systems are experiencing a major outage". Otherwise "All Systems Operational"

I feel this could be improved a lot. Suggestions on how the logic should be are welcome

If you are interested in this GitHub Issue leave a comment so I can put this as priority.

Would it support for private repo?

Thanks for the lovely tool, I wonder would it support for those private repos?

CDN

GitHub Pages

npm run build doesn't work

following the steps you provide "npm run build" won't work because there are no "react-scripts" in there

You first need to run "npm install"

Otherwise nothing will happen :)

Release under a licence

Unless you include a license that specifies otherwise, nobody else can copy, distribute, or modify your work without being at risk of take-downs, shake-downs, or litigation.

https://choosealicense.com/no-permission/

This work is unlicensed mostly as I hadn't decided on which one. This is not ideal for users as mentioned above.

This will likely be licenced under MIT however I might consider GPLv3 to keep modifications open source or something more restrictive to stop commerical re-selling.

Scheduled Maintenance

Could we have a Scheduled Maintenance section, that we can add too?

Mobile App

Setup

Hello.

I'm trying to run issue status on my own website/domain, but I don't really understand how to setup and where to run commands like "npm run build" etc.
I don't use GitHub often.

Detailed instructions would be very helpful, thanks!

Implement incidents

This will use GitHub Issues with tag issue status and incident.

These will be similar to https://demo.cachethq.io Past Incidents.

Incidents won't update or relate to a component as I don't see a way of relating them.

Our services may be temporarily unavailable

During routine upgrades to our services we identified an increased error rate on our API. We are currently investigating the issue and will continue to provide updates

Apologies for any inconveniences.

Add sub-components

Maybe categories for components would be nice? It's kinda annoying if you're for example hosting two different domains and they are all mixed up.

Markdown support

Incident reporting needs markdown support to match GitHub Issues markdown.

Should be fairly simple using the react-markdown package however you may run into issues as GitHub have their own markdown spec

If you are interested in this GitHub Issue leave a comment so I can put this as priority.

Localisation

add messages to a localisation file so they can easily be translated

Chart support

This will use the react-chartjs-2 React npm package

You can create a Chart on the status page by creating an issue with labels status issue and chart. the body of the issue will be striped to find a url for the data source - maybe a better way?

Data source url will need to include labels and datasets

This will be useful for having response time charts etc

A major issue with adding more things is increasing the calls to the GitHub API. It is possible to make a single call instead of multiple however you can then run into issues with pagination. We would need to increase requests per fetch to 3 (Components, Incidents and Charts).

If you are interested in this GitHub Issue leave a comment so I can put this as priority.

Increase requests per hour

Currently GitHub has a rate limit of 60 requests per hour with unauthenticated requests (GitHub API v3 | GitHub Developer Guide)

Issue Status fetches 15 per hour, each fetch sends 2 requests and caches the response in localStorage. This is to stay under the rate limit (users might be using the GitHub API elsewhere.

There is no limit on the apps reload button

This could be increased

Unable to deploy to github pages

I have just pulled in upstream changes and now cant deploy them, I get an error

> [email protected] predeploy
> npm run build


> [email protected] build
> react-scripts build

Creating an optimized production build...
Error: error:0308010C:digital envelope routines::unsupported
    at new Hash (node:internal/crypto/hash:80:19)
    at Object.createHash (node:crypto:139:10)
    at module.exports (/Users/matt/git/issue-status/node_modules/webpack/lib/util/createHash.js:135:53)
    at NormalModule._initBuildHash (/Users/matt/git/issue-status/node_modules/webpack/lib/NormalModule.js:417:16)
    at handleParseError (/Users/matt/git/issue-status/node_modules/webpack/lib/NormalModule.js:471:10)
    at /Users/matt/git/issue-status/node_modules/webpack/lib/NormalModule.js:503:5
    at /Users/matt/git/issue-status/node_modules/webpack/lib/NormalModule.js:358:12
    at /Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:373:3
    at iterateNormalLoaders (/Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:214:10)
    at iterateNormalLoaders (/Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:221:10)
    at /Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:236:3
    at runSyncOrAsync (/Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:130:11)
    at iterateNormalLoaders (/Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:232:2)
    at Array.<anonymous> (/Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:205:4)
    at Storage.finished (/Users/matt/git/issue-status/node_modules/enhanced-resolve/lib/CachedInputFileSystem.js:55:16)
    at /Users/matt/git/issue-status/node_modules/enhanced-resolve/lib/CachedInputFileSystem.js:91:9
/Users/matt/git/issue-status/node_modules/react-scripts/scripts/build.js:19
  throw err;
  ^

Error: error:0308010C:digital envelope routines::unsupported
    at new Hash (node:internal/crypto/hash:80:19)
    at Object.createHash (node:crypto:139:10)
    at module.exports (/Users/matt/git/issue-status/node_modules/webpack/lib/util/createHash.js:135:53)
    at NormalModule._initBuildHash (/Users/matt/git/issue-status/node_modules/webpack/lib/NormalModule.js:417:16)
    at /Users/matt/git/issue-status/node_modules/webpack/lib/NormalModule.js:452:10
    at /Users/matt/git/issue-status/node_modules/webpack/lib/NormalModule.js:323:13
    at /Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:367:11
    at /Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:233:18
    at context.callback (/Users/matt/git/issue-status/node_modules/loader-runner/lib/LoaderRunner.js:111:13)
    at /Users/matt/git/issue-status/node_modules/babel-loader/lib/index.js:59:103 {
  opensslErrorStack: [
    'error:03000086:digital envelope routines::initialization error',
    'error:0308010C:digital envelope routines::unsupported'
  ],
  library: 'digital envelope routines',
  reason: 'unsupported',
  code: 'ERR_OSSL_EVP_UNSUPPORTED'
}

Node.js v21.7.1

Hi how can i setup it?

Hi i cloned repo, edited .env and i see same status page as this https://tadhglewis.github.io/issue-status/
I tried to run npm run build and npm run deploy
but it didnt work

Website not connected to Github

Whenever I try and use my website, it shows the issues from here when I configured it. It only works when I used a Localhost. Can you try and fix this please?

Implement API

It would be nice to have a node API which can easily be run on a server to handle automating Component / Incident reporting, currently reporting is manual, using a service or the GitHub API directly to add/edit components and incidents

An API wrapper for the GitHub API which will expose simplified endpoints to help integrate with services. Example listens for requests on https://example.com/CDN?status=major outage and updates the current label for CDN to major outage

If you are interested in this GitHub Issue leave a comment so I can put this as priority.

Documentation

Documentation always needs improving.

blank website

Hey! I recently did set up your issue. Now I connected my gh-pages to GutHubPages and when I'm going to open my website it's a plank white website. And I don't know where is there an issue.

Unknown problem.

Hello there! I am trying to use your Status page. But I am having big problems. Coming to my problem, when I translate some of the content into my own language, the Status texts turn into Unknown (in translated language: "Bilinmiyor").

Despite the transformation, everything is running smoothly in the main status.

Eftelya is performance issues and Tracer is operational but as you see that's not works.

There are two files that I translated.

I made the changes I made in one file in the second file. I also paid attention to all the quotation marks in the map file, which is more complicated than the other. I have a few days to deal with this situation. It would be great if you could get back to me early.

Sincerely,
Magdalena Sude.

Cant see the description in de incident issues

Hi,

when creating an issue with the incident label. The title is shown but not the content of the description

Add sub-components

For example https://www.cloudflarestatus.com/

This is useful for large services and region-based like VPNs, data centres etc

Before

• CDN - Oceania
• CDN - Europe
• CDN - South East Asia

After

• CDN
  • Oceania
  • Europe
  • South East Asia

Updated install

Hello,

With the overhaul you've done, how do I now get Github pages setup?

Markdown support broken

Hey!
Looks like Markdown isn't working in Incidents (not even on your demo site, https://tadhglewis.github.io/issue-status/). maybe it's worth fixing?
~ cxt

An issue

Payment Processor

Investigate and add data providers for CMS

Data providers are now supported. This allows you to fetch data from anywhere and format/map it to "issue-status format".

This should allow essentially any CMS to be the data source instead of GitHub issues.

• SaaS CMS?
• Static JSON files? - e.g. you may have a service which generates them on a cron
• RSS?
  Etc

Use TypeScript

Under consideration

If you are interested in this GitHub Issue leave a comment so I can put this as priority.

test

test

Website

API scheduled maintenance

We will be performing scheduled maintenance from June 11, 2020 12:00 AM UTC to June 11, 2020 3:00 AM UTC.

During this time, our API and Mobile App will be unavailable and will respond with 503.

Dark mode support

Because productivity or something 🤷

[Question] Public or provate repo?

Do you need to use a private or public repo on GitHub?

And, if it's a public repo, can anyone open an issue and this will appear on the status page? I don't understand this.

System degraded performance

Resolved: This incident has been resolved.

Monitoring: We have implemented a fix and we are continuing to monitor the incident.

Update: We have identified a bad actor attempting to overload our systems which has resulted in performance degradation for other users.

Identified: We have identified the issue and a fix is being implemented.

Investigating: We are currently investigating degraded performance.

API

[BUG] <title>

Is there an existing issue for this?

• I have searched the existing issues

Current Behavior

<-- This is commented out. -->

Expected Behavior

abl

Steps To Reproduce

bla

Environment

- OS:
- Node:
- npm:
fervre

Anything else?

vrwver

test-issue

testing the issues

Installation on Plesk and requirements

Hello,
is it possible to install the site on Plesk?
Could you perhaps list minimum requirements for installation on the GitHub page?