Skip to content

Commit 7279f81

Browse files
committed
Update README with local setup instructions
1 parent a8e1b08 commit 7279f81

File tree

2 files changed

+15
-8
lines changed

2 files changed

+15
-8
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ versions.json
1717
.svn
1818
/credentials.json
1919
*.pem
20+
.env

README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,25 @@
44

55
`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.
66

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+
714
## :wrench: Setup
815

9-
* Clone this repo.
16+
* Clone this repo
1017
* `npm install`
11-
* Start the app
12-
* `npm start` to start it as a GitHub APP
18+
* `npm test`
1319

14-
### ENV variables required:
20+
To start the server locally, you'll need:
1521

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.
2026

2127
#### Adding plugins
2228

0 commit comments

Comments
 (0)