Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oscard0m/example-probot-vercel-ts

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/oscard0m/example-probot-vercel-ts
Owner: oscard0m
License: isc
Created: 2022-08-29T18:54:29.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-10-24T07:52:54.000Z (3 months ago)
Last Synced: 2024-10-25T04:10:53.848Z (3 months ago)
Language: TypeScript
Homepage: example-vercel-ts.vercel.app
Size: 219 KB
Stars: 10
Watchers: 1
Forks: 2
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        # Probot & Vercel example

This repository is an example of how to deploy the "Hello, World" of probot apps to [Vercel](https://vercel.com).

## Local setup

Install dependencies

```

npm install

```

Build the project

```

npm run build

```

Start the server

```

npm start

```

Follow the instructions to register a new GitHub app.

## Deployment

The app is continuously deployed using [Vercel's GitHub app](https://github.com/apps/vercel).

### Considerations

- Make sure you configure [the environment variables for your GitHub App](https://probot.github.io/docs/configuration/) in Vercel. You can read more about how to do it in [their docs](https://vercel.com/docs/concepts/projects/environment-variables).

- Vercel [expects to find your lambda functions under `/api` folder]([url](https://vercel.com/docs/concepts/functions/serverless-functions#deploying-serverless-functions)). Make sure your functions are placed there and double check Vercel detected your Lambda Functions during the deployment process by checking the logs:

![image](https://user-images.githubusercontent.com/2574275/187179364-b0019f95-be41-462a-97d5-facf4de39095.png)

## How it works

The [api/github/webhooks/index.js](api/github/webhooks/index.js) file is handling requests to `POST /api/github/webhooks`, make sure to configure your GitHub App registration's webhook URL accordingly.

## License

[ISC](LICENSE)