Giter VIP home page Giter VIP logo

pd-live-react's Introduction

PagerDuty Live

This repository hosts the source code for PagerDuty Live, an open-source, single page application which enables organisations to manage their PagerDuty incidents in real-time through a unified console view.

Application URL: https://giranm.github.io/pd-live-react/

โš ๏ธ Disclaimer

This project is not officially supported by PagerDuty and therefore no issues can be reported to or resolved by PagerDuty Support. This is an open-source project designed to be used in a safe/test environment before users can leverage on their primary domains.

Screenshot

Screenshot 2021-11-05 at 18 35 16

Development

(Optional) Register PagerDuty App

If you wish to maintain + deploy your own version of PagerDuty Live, we recommend registering a new OAuth app as follows:

  • Within PagerDuty developer mode, register a new app
  • Add OAuth 2.0 workflow to the app and update the URL to the app entrypoint
    (see GitHub deployment steps below as an example)

Local Development

  1. Install NodeJS v16.13 (or switch using asdf install)

  2. Install craco via $ yarn install @craco/craco --save --global
    (NB - you may need to reload terminal session to use the alias)

  3. $ git clone repo to desired destination and $ cd pd-live-react into directory.

  4. (Optional) Create .env file in project root with overriding configuration (see section below for details)

  5. Install dependencies with $ yarn install and run application locally using $ yarn start
    The app will be available under http://localhost:3000/pd-live-react

Environment Overrides

The following optional parameters can be used in a .env file to override PagerDuty Live during local serve (yarn start):

Parameter Usage
REACT_APP_PD_OAUTH_CLIENT_ID PagerDuty OAuth App client ID (created upon registering app)
REACT_APP_PD_OAUTH_CLIENT_SECRET PagerDuty OAuth App client secret (created upon registering app)
REACT_APP_PD_USER_TOKEN PagerDuty Personal API Token; this will override OAuth login workflow if set
REACT_APP_PD_SUBDOMAIN_ALLOW_LIST Comma separated list of allowed subdomains (e.g. acme-prod,acme-dev)

License

MIT License

Copyright (c) 2021 Giran Moodley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pd-live-react's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.