Skip to content

Commit

Permalink
docs: README.md updated
Browse files Browse the repository at this point in the history
  • Loading branch information
ASHWIN776 committed Aug 30, 2024
1 parent 034799c commit 01b3b16
Showing 1 changed file with 2 additions and 42 deletions.
44 changes: 2 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,3 @@
# Probot & Vercel example
## Payobvio Github App

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)
Github App for the Payobvio project. Works side by side with the [Payobvio Nextjs app](https://github.com/payobv-io/payobv.io)

0 comments on commit 01b3b16

Please sign in to comment.