Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(probot): adding more instructions to readme #13

Merged
merged 1 commit into from
Oct 23, 2024
Merged

docs(probot): adding more instructions to readme #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions src/probot/example-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# example-app
# Probot Example App

> A GitHub App built with [Probot](https://github.com/probot/probot) that An example Probot App.
A GitHub App built with [Probot](https://github.com/probot/probot) that represents an example Probot App. It creates the local application using Javascript ([index.js](index.js)) listening to the `"issues.opened"` event on GitHub and commenting on the created issue once it is opened. The app also sets up an [smee.io](https://smee.io) channel which can be used to observe the webhook event.

## Setup

Expand All @@ -11,6 +11,9 @@ npm install
# Run the bot
npm start
```
Once stared, the app is available at `localhost:3000`. On the first start, the app will ask you to create a GitHub App. Do so and select the target user namespace or organisation. Probot takes care of all configurations. Custom settings, such as, repository access can be made once the GitHub App finished installing. After everything is set, restart the local app and reopen `localhost:3000`. The Probot app is now up and running and ready for testing.

## Use the App

## Docker

Expand All @@ -26,8 +29,4 @@ docker run -e APP_ID=<app-id> -e PRIVATE_KEY=<pem-value> example-app

If you have suggestions for how example-app could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the [Contributing Guide](CONTRIBUTING.md).

## License

[ISC](LICENSE) © 2024 @spindev
For more, check out the [Contributing Guide](../../../CONTRIBUTING.md).