Skip to content

Commit 337d22b

Browse files
committed
Remove redundant documentation
Documentation is at https://microfeedback.js.org/backends/microfeedback-github
1 parent 04756b9 commit 337d22b

1 file changed

Lines changed: 1 addition & 91 deletions

File tree

README.md

Lines changed: 1 addition & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -12,97 +12,6 @@ An easily-deployable microservice for collecting user feedback as GitHub issues.
1212

1313
https://microfeedback.js.org/backends/microfeedback-github/
1414

15-
## API
16-
17-
#### `POST /<github-user>/<github-repo>`
18-
19-
Post a new feedback message on the issue tracker for the given GitHub
20-
repo.
21-
22-
The JSON payload contains the following keys:
23-
24-
- `body` (required): The feedback content.
25-
- `screenshotURL`: Optional URL to a screenshot image.
26-
- `extra`: Optional object containing optional information to include in the issue.
27-
28-
## Deploy to [now](https://zeit.co/now)
29-
30-
If you already have a [now](https://zeit.co/now) account and a GitHub
31-
API token associated with your feedback bot, you can deploy
32-
microfeedback-github to now using the `now` CLI.
33-
34-
### One command deploy
35-
36-
Use the `now` CLI to deploy this repo.
37-
38-
```
39-
now microfeedback/microfeedback-github
40-
```
41-
42-
You will be prompted to enter the GitHub API token associated
43-
with your feedback bot's GitHub account.
44-
45-
For more detailed setup instructions, see the next section.
46-
47-
## Detailed instructions
48-
49-
- Sign in to the GitHub account that will post issues, e.g. `myapp-issuebot`.
50-
- Go [here](https://github.com/settings/tokens/new) to generate a new personal access token.
51-
- Enter a description, e.g. "For posting issues" and select the "repo" scope.
52-
53-
![](media/personal-access-token.png)
54-
55-
- Click "Generate token" and copy the token.
56-
57-
- Set up an account with now and install the now client. See [here](https://zeit.co/now) for details.
58-
- Deploy the service with `now`. You must pass the following environment variables:
59-
- `GH_TOKEN`: The access token you just created.
60-
61-
```
62-
now microfeedback/microfeedback-github -e GH_TOKEN=<bot's github token>
63-
```
64-
65-
- You're done! Copy the URL returned by `now`. This is the URL clients will use to access the service.
66-
67-
## Deploy to Heroku
68-
69-
If you prefer to deploy to Heroku, use the deployment button below or
70-
deploy with Git.
71-
72-
### One click deploy
73-
74-
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
75-
76-
### Deployment with git
77-
78-
You can also deploy with git and the heroku CLI.
79-
80-
```
81-
git clone https://github.com/microfeedback/microfeedback-github.git
82-
cd microfeedback-github
83-
heroku create
84-
heroku config:set GH_TOKEN=<bot's github token>
85-
git push heroku master
86-
```
87-
88-
## Configuration
89-
90-
Configuration is defined through environment variables and can be passed
91-
when you deploy microfeedback-github.
92-
93-
```
94-
now microfeedback/microfeedback-github -e GH_TOKEN=abc123 -e ALLOWED_REPOS=sloria/website,sloria/another-website
95-
```
96-
97-
The following options are available:
98-
99-
- `GH_TOKEN` (required): The GitHub API token associated with your
100-
feedback bot's account.
101-
- `ALLOWED_REPOS`: A comma-delimited list of GitHub repos that maybe
102-
posted to. If `'*'`, allow posting to any repo
103-
that the `GH_TOKEN` has access to (incl. any
104-
public repos). Default: `'*'`
105-
10615
## Development
10716

10817
* Fork and clone this repo. `cd` into the project directory.
@@ -123,6 +32,7 @@ npm run test:debug
12332

12433
## Related
12534

35+
- [microfeedback-jira](https://github.com/microfeedback/microfeedback-jira)
12636
- [microfeedback-core](https://github.com/microfeedback/microfeedback-core)
12737

12838
## License

0 commit comments

Comments
 (0)