https://github.com/layershifter/screener-proxy
https://github.com/layershifter/screener-proxy
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/layershifter/screener-proxy
- Owner: layershifter
- Created: 2020-09-01T11:26:36.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-08T09:28:19.000Z (over 5 years ago)
- Last Synced: 2025-09-12T12:38:32.162Z (9 months ago)
- Language: TypeScript
- Homepage: https://screener-proxy.vercel.app
- Size: 21.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# screener-proxy
This Github App is designed only to be used with [Fluent UI React Northstar](https://github.com/microsoft/fluentui/tree/master/packages/fluentui). It provides the integration between [Screener](https://screener.io/) and Github.
### How it works?
There are two API endpoints:
- `/api/github` - an endpoint for a Github App, listens for PR webhooks from Github and creates a [Github check](https://docs.github.com/en/rest/reference/checks)
- `/api/screener` - an endpoint for a Screener, listens for [webhooks from Screener](https://screener.io/v2/docs/webhooks) that can mark a created previously check as failed or successful
### Deployment
This repo uses [Vercel](https://vercel.com/) for deployments, any push to the `master` branch will trigger a production deployment.