https://github.com/probot/example-begin

Probot & Begin.com example
https://github.com/probot/example-begin

Last synced: 8 months ago
JSON representation

Probot & Begin.com example

• Host: GitHub
• URL: https://github.com/probot/example-begin
• Owner: probot
• License: isc
• Created: 2021-02-09T23:48:20.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2025-01-28T08:36:10.000Z (over 1 year ago)
• Last Synced: 2025-01-29T19:46:42.106Z (over 1 year ago)
• Language: JavaScript
• Homepage: https://begin.com
• Size: 1.15 MB
• Stars: 2
• Watchers: 2
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Probot & Begin example

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

[![Begin build status](https://buildstatus.begin.app/dream-zdj/status.svg)](https://begin.com)

## Deploy your own

[![Deploy to Begin](https://static.begin.com/deploy-to-begin.svg)](https://begin.com/apps/create?template=https://github.com/probot/example-begin)

Deploy your own clone of this app to Begin!

Once deployed, make sure to configure the environment variables for your production environment once you [registered a GitHub App](https://github.com/settings/apps/new)

1. `APP_ID`

2. `PRIVATE_KEY` (base64 encoded, you can do that [here](https://www.base64encode.org/))

3. `WEBHOOK_SECRET`

## Local setup

- Start the local dev server: `npm start`

- Run your tests: `npm test`

## Reference

- [Probot](https://probot.github.io/docs/) - The Probot documentation

- [Begin Quickstart](https://docs.begin.com/en/guides/quickstart/) - basics on working locally, project structure, deploying, and accessing your Begin app

- [Creating new routes](https://docs.begin.com/en/functions/creating-new-functions) - basics on expanding the capabilities of your app

Head to [docs.begin.com](https://docs.begin.com/) to learn more about Begin!