probot
π€ A framework for building GitHub Apps to automate and improve your workflow
File Explorer
Download Latest Version (.zip)- ci.json
- Bug_report.md
- Feature_request.md
- codeql.yml
- docs.yml
- release.yml
- test.yml
- CODEOWNERS
- config.yml
- issue_label_bot.yaml
- release-drafter.yml
- renovate.json
- stale.yml
- typedoc_ga.mjs
- probot.js
- best-practices.md
- configuration.md
- deployment.md
- development.md
- extensions.md
- github-api.md
- hello-world.md
- http.md
- logging.md
- pagination.md
- persistence.md
- README.md
- simulating-webhooks.md
- testing.md
- webhooks.md
- node-middleware.mjs
- prepare-static-files-to-ts.js
- publish-docs
- default.ts
- setup.ts
- probot.ts
- read-cli-options.ts
- read-env-options.ts
- receive.ts
- apply-env.ts
- create-deferred-promise.ts
- detect-runtime.ts
- get-error-handler.ts
- get-log.ts
- get-payload.ts
- get-printable-host.ts
- get-runtime-name.ts
- get-runtime-version.ts
- is-production.ts
- is-supported-runtime.ts
- load-env.ts
- load-package-json.ts
- resolve-app-function.ts
- update-env.ts
- validate-log-format.ts
- validate-log-level.ts
- webhook-proxy.ts
- get-authenticated-octokit.ts
- get-octokit-throttle-options.ts
- get-probot-octokit-with-defaults.ts
- get-webhooks.ts
- octokit-plugin-probot-request-logging.ts
- octokit-webhooks-transform.ts
- probot-octokit.ts
- http-logger.ts
- not-found.ts
- ping.ts
- static-files.ts
- server.ts
- primer.css.ts
- probot-head.svg.ts
- robot.svg.ts
- import.ts
- probot.ts
- setup.ts
- success.ts
- context.ts
- create-node-middleware.ts
- create-probot.ts
- exports.ts
- index.jsr.ts
- index.ts
- manifest-creation.ts
- probot.ts
- run.ts
- types.ts
- version.ts
- primer.css
- probot-head.svg
- robot.svg
- default.test.ts
- setup.test.ts
- detect-runtime.test.ts
- is-supported-runtime.test.ts
- e2e.test.ts
- hello-world.cjs
- hello-world.mjs
- basic.yml
- empty.yml
- evil.yml
- malformed.yml
- missing.yml
- empty-string.json
- empty.json
- invalid.json
- null.json
- stub-plugin.ts
- stub-typescript-transpiled-plugin.ts
- response.json
- push.json
- example.js
- test-private-key.pem
- is-production.test.ts
- load-package-json.test.ts
- update-env.test.ts
- validate-log-format.test.ts
- validate-log-level.test.ts
- integration-add-handler.test.ts
- integration-cli-help.test.ts
- integration-cli-version.test.ts
- integration-smee-create-channel.test.ts
- integration-smee.test.ts
- utils.ts
- http-logger.test.ts
- probot.test-d.ts
- import.test.ts.snap
- probot.test.ts.snap
- setup.test.ts.snap
- success.test.ts.snap
- import.test.ts
- probot.test.ts
- setup.test.ts
- success.test.ts
- context.test.ts
- create-node-middleware.test.ts
- create-probot.test.ts
- deprecations.test.ts
- manifest-creation.test.ts
- npx-import.test.ts
- probot-octokit.test.ts
- probot.test.ts
- resolver.test.ts
- run.test.ts
- server.test.ts
- tsconfig.json
- utils.ts
- webhook-proxy.test.ts
- .editorconfig
- .gitignore
- .typedoc.json
- CODE_OF_CONDUCT.md
- codecov.yml
- CONTRIBUTING.md
- jsr.json
- LICENSE
- package-lock.json
- package.json
- README.md
- tsconfig.json
- vitest.config.ts
π Installation Guide
1. Get the code
git clone https://github.com/probot/probot
Downloads the entire project code from GitHub to your computer.
cd probot
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation
Was this content helpful?
(0 ratings)