You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-8Lines changed: 14 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -4,19 +4,25 @@
4
4
5
5
`eslint-github-bot` is a bot created with [probot](https://github.com/probot/probot) which automates some common tasks for repositories run by the ESLint team.
6
6
7
+
## Environment Variables:
8
+
9
+
*`APP_ID` (required): The numeric GitHub app ID
10
+
*`PRIVATE_KEY` (required): the contents of the private key you downloaded after creating the app.
11
+
*`WEBHOOK_SECRET` (required): Secret setup for GitHub webhook or you generated when you created the app.
12
+
*`PORT`: Port for web server _(optional, defaults to 8000)_.
13
+
7
14
## :wrench: Setup
8
15
9
-
* Clone this repo.
16
+
* Clone this repo
10
17
*`npm install`
11
-
* Start the app
12
-
*`npm start` to start it as a GitHub APP
18
+
*`npm test`
13
19
14
-
### ENV variables required:
20
+
To start the server locally, you'll need:
15
21
16
-
*`PORT`: Port for web server _(optional, defaults to 8000)_.
17
-
*`WEBHOOK_SECRET`: Secret setup for GitHub webhook or you generated when you created the app.
18
-
*`PRIVATE_KEY`: the contents of the private key you downloaded after creating the app.
19
-
*`APP_ID`: The numeric GitHub app ID
22
+
*A PEM file
23
+
*A `.env` file that specifies the required environment variables
24
+
25
+
The`APP_ID` and `WEBHOOK_SECRET` need to be present but need not be the registered application ID or webhook secret to start the server. `PRIVATE_KEY` must be a valid PEM private key.
0 commit comments