Simple, modern and flexible status page
Issue Status is the static client-side status page built on React using GitHub Issues for Component and Incident reporting with live updating using the GitHub API, there is no need to rebuild and redeploy for every update. All hosted on GitHub Pages
You can view the Issue Status demo here. This demo is hosted on GitHub Pages
git checkout tags/VERSION
to checkout to the latest version. It is not recommended to setup using the master branch.env
file found in the root directory and enter your configuration optionsnpm run deploy
this will build the React project and deploy it to the gh-pages
branchgh-pages
branchnpm run build
this will create a build directory containing the built appYou may also want to configure issue templates for your repository which will act as Component and Incident templates. Including the issue status
label in an issue template will allow unauthorised GitHub users to update the status page, this should be added when creating the issue
Updating is important to get the latest features and patches
.env
configuration file as this may be overwritten, you will need to make sure you include the env variables from the latest versiongit checkout tags/VERSION
to checkout to the latest version. It is not recommended to setup using the master branchnpm run deploy
to deploy the latest version to GitHub Pagesnpm run build
to create a new build directoryIntegrate and automate Components and Incidents, this may be useful for changing a Component to major outage
when you detect your services aren't running or performance issues
when the response time goes over a set point.
Customise your status page - ensure all required options are entered and any unused optional options are set blank, ie REACT_APP_MANIFEST=
REACT_APP_MANIFEST
(optional) - Determines the manifest url in the built HTML fileREACT_APP_TITLE
(required) - Determines the <title>
tag in the built HTML file with suffix Status
REACT_APP_DESCRIPTION
(optional) - Determines the description <meta>
tag in the built HTML fileREACT_APP_LOGO
(optional) - Accepts an image URL and is used in the status page headerREACT_APP_NAME
(optional) - Used in the status page header when no REACT_APP_LOGO
is provided. This will be used in the img alt attribute if a logo is providedREACT_APP_REPOSITORY
(required) - GitHub username/repository
that Components and Incidents will be fetched from, ie tadhglewis/issue-status
In depth overview of the functionality
operational
= "Some systems are experiencing issues", more than 0 Components major outage
= "Some systems are experiencing a major outage". Otherwise, "All Systems Operational"Component
each display a current status. To create a Component add tags issue status
, component
and a tag for the current status: operational
, performance issues
, partial outage
or major outage
(if an issue only has issue status
and component
it will be listed as Unknown
) to a GitHub Issue. You can view all the demo Components hereIncident
will show in the Incidents section as either Active
or Closed
depending whether on the GitHub Issue is Open or Closed. To create an Incident add tags issue status
and incident
to a GitHub Issue. You can view all the demo Incidents hereIf you have any issues or questions feel free to contact me or create an issue
1.1.0