https://github.com/clement-joye/dashboard-rest-api

An angular dashboard querying the rest API of different CI provider to monitor pipelines.
https://github.com/clement-joye/dashboard-rest-api

Last synced: 15 days ago
JSON representation

An angular dashboard querying the rest API of different CI provider to monitor pipelines.

• Host: GitHub
• URL: https://github.com/clement-joye/dashboard-rest-api
• Owner: clement-joye
• License: apache-2.0
• Created: 2021-05-14T23:00:53.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-05-15T13:38:06.000Z (over 3 years ago)
• Last Synced: 2024-11-11T15:50:13.622Z (2 months ago)
• Language: TypeScript
• Size: 151 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dashboard-rest-api

An angular dashboard querying the rest API of different CI provider to monitor pipelines. 

![image](https://user-images.githubusercontent.com/57441858/118363188-802a2e00-b593-11eb-9c04-0c9d50ad3ed7.png)

# Requirements

Node v14.15.x or later

Angular 11.x or later

# Personal access tokens

Generate personal access tokens (pat) in all CI providers needed (required to uery rest APIs of CI providers).🔑

Look here for [DevOps](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page) and [GitHub](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) regarding how to generate your own pat.

# Install

Run ```npm install```

In data.ts, for each item in cards replace the values with your own:

```

{ "family": "Acme", "name": "API Tests Dev", "datasource": "devops-build", "pat": "yourPersonalAccessToken", 

    "variables": {

        "organization": "someOrganisationName",

        "project": "someProjectName",

        "definition": "someBuildName"

    } 

},

```

# Serve

Make sure to do the above and simply run ```ng serve``` for testing purpose.

# Deploy locally

 For deploying your app locally without web server, bundle your app directly to deploy locally with ```ng build --configuration production```

 You can then copy/paste your _dist/_ folder anywhere and open the _index.html_ file with your browser.

> NB: If building your app, make sure to remove that line from yoru index.html file ``````.

# Going further

Have a look at the different rest APIs from your favorite CI providers, and add some more logic (create/update resources, retrieve other resources etc.) to fit your own needs.

See here for [DevOps Azure](https://docs.microsoft.com/en-us/rest/api/azure/devops/) and [GitHub](https://docs.github.com/en/rest/reference) rest APIs documentation :toolbox:

See the following [post](https://clementjoye.medium.com/build-a-local-dashboard-to-overview-your-different-pipelines-902046b34f0c) on Medium for more info.

Don't hesitate if you have any questions.