To develop a Probot app, you will first need a recent version of Node.js installed. Open a terminal and run
node -v to verify that it is installed and is at least 8.3.0 or later. Otherwise, install the latest version.
create-probot-app is the best way to start building a new app. It will generate a new app with everything you need to get started and run your app in production.
To get started, run one of these commands:
$ npx create-probot-app my-first-app
$ yarn create probot-app my-first-app
create-probot-appaccepts an optional
templateargument which accepts the following values:
basic-ts(use this one for TypeScript support).
This will ask you a series of questions about your app, which should look something like this:
Let's create a Probot app! ? App name: my-first-app ? Description of app: A "Hello World" GitHub App built with Probot ? Author's full name: Katie Horne ? Author's email address: firstname.lastname@example.org ? Homepage: ? GitHub user or org name: khorne3 ? Repository name: my-first-app ? Which template would you like to use? (Use arrow keys) ❯ basic-js checks-js git-data-js deploy-js basic-ts created files... Finished scaffolding files! Installing Node dependencies! Done! Enjoy building your Probot app!
The most important files note here are
index.js, which is where the code for your app will go, and
package.json, which makes this a standard npm module.
Now you're ready to run the app on your local machine. Run
npm run dev to start the server:
Note: If you're building a TypeScript app, be sure to run
npm run buildfirst!
> email@example.com dev /Users/hiimbex/Desktop/testerino > nodemon [nodemon] 1.18.4 [nodemon] to restart at any time, enter `rs` [nodemon] watching: .env *.* [nodemon] starting `npm start` > firstname.lastname@example.org start /Users/hiimbex/Desktop/testerino > probot run ./index.js 01:57:22.365Z INFO probot: Welcome to Probot! Go to http://localhost:3000 to get started. 01:57:22.428Z INFO probot: Forwarding https://smee.io/1S10MsoRSjZKWKMt to http://localhost:3000/ 01:57:22.431Z INFO probot: Listening on http://localhost:3000 01:57:22.564Z INFO probot: Connected https://smee.io/1S10MsoRSjZKWKMt
dev script will start your app using nodemon, which will watch for any files changes in your local development environment and automatically restart the server.
To automatically configure your GitHub App, follow these steps:
npm run dev.
.envand notice it will be populated with values GitHub sends us in the course of that redirect.
GitHub App Manifests--otherwise known as easy app creation--make it simple to generate all the settings necessary for a GitHub App. This process abstracts the Configuring a GitHub App section. You can learn more about how GitHub App Manifests work and how to change your settings for one via the GitHub Developer Docs.
If you created an App with a manifest, you can skip this section; your app is already configured! If you ever need to edit those settings, you can visit
To run your app in development, you will need to configure a GitHub App to deliver webhooks to your local machine.
.envto the URL that you are redirected to.
WEBHOOK_PROXY_URLfrom the previous step.
development(Note: For optimal security, Probot apps require this secret be set, even though it's optional on GitHub.).
APP_IDto the ID of the app you just created. The App ID can be found in your app settings page here
You'll need to create a test repository and install your app by clicking the "Install" button on the settings page of your app, e.g.
Other available scripts
$ npm startto start your app without watching files.
$ npm run lintto lint your code using standard.
$ npm installand restart the server if
$ LOG_LEVEL=trace npm start
Found a mistake or want to help improve this documentation? Suggest changes on GitHub