Skip to content

binodswain/status-page

Repository files navigation

Status page

license update and build site Netlify Status

🚧 WIP 🚧

a simple and fast status page built with Gatsby.

Demo status site

gh-page: https://binodswain.github.io/status-page/

netlify: https://status-demo.binodswain.dev/

TOC:

  • Getting started

  • Deploy site in

    • gh-pages
    • netlify
  • Configuration

    • Service list
    • SEO
    • Poll duration
  • Miscellaneous

    • environment variables

Getting started 💻

This website is built to work best with github pages and netlify. Host completely free with Netlify or gh-pages.

Deploy site in gh-pages

  1. fork this repository

  2. update repository secrets. these secrets will be required in the github action.

    a. REPO_TOKEN : a github auth token to fetch issue list and generate site data
    
    b. REPO_OWNER : repository owner
    
    c. REPO : repository name
    

    Screenshot 1

To test locally, create a .env file and add secrets in below format.

REPO_TOKEN = xxxxxxxxxxxxxxxxxxxxxxxxxxxx
REPO_OWNER = binodswain
REPO = status-page
  1. Update ./site-config.js according to your requirement and add those changes to repo.

  2. Update GitHub Pages setting of repo to serve the static site from docs folder of default branch.

    Screenshot 1 Note: Content of docs folder will be published. build-path script in package.json builds site with path-prefix and populates public folder.

Deploy site in netlify

  1. fork this repository

  2. select "new site with git" option ➡ github ➡ forked repo.

  3. proceed with defail options. Click on "show advanced" and add below environment variables.

    a. REPO_TOKEN
    
    b. REPO_OWNER
    
    c. REPO
    
    d. NETLIFY
    

    Screenshot 2 Screenshot 3

License

MIT © binodswain