Search HTTP API for webcompat issues
Перейти к файлу
Karl Dubost 02b0216f2b
Merge pull request #2 from Mozilla-GitHub-Standards/master
Add Mozilla Code of Conduct
2021-05-04 11:05:23 +09:00
docker Use same python version in pipfile and docker 2019-12-09 17:51:09 +01:00
webcompat_search Black styling fixes 2019-12-10 13:30:33 +01:00
.gitignore Update .gitignore 2019-03-12 19:08:01 +01:00
CODE_OF_CONDUCT.md Add Mozilla Code of Conduct file 2019-03-30 00:11:33 -07:00
LICENSE Bootstrap repository for flask app. 2018-08-10 16:55:11 +03:00
Pipfile Upgrade python and dependencies 2019-11-26 17:05:02 +01:00
Pipfile.lock Bump urllib3 from 1.25.7 to 1.25.8 2021-04-30 20:47:30 +00:00
Procfile Escape parenthesis to fix bash call. 2018-09-19 15:58:33 +02:00
README.md Remove unused flask views 2019-11-26 16:03:26 +01:00
docker-compose.yml Fix elasticsearch version. Expose ES for local development. 2019-03-07 12:36:15 +01:00
setup.cfg Bootstrap repository for flask app. 2018-08-10 16:55:11 +03:00

README.md

webcompat-search

Description

Utility to help with common tasks related to webcompat ES:

  • flask
  • elasticsearch

Initial configuration

We scrape github issues using Github API which requires a token for authentication. Get a personal access token following the instructions here.

Then setup the configuration using the following commands (in the toplevel of the project):

$ touch .env
$ echo "GITHUB_API_TOKEN = <GITHUB_API_TOKEN>" >> .env

You also need to install docker and docker-compose.

Building

  • docker-compose pull to pull the dependent images
  • docker-compose build to build the image for the service

Getting started

To populate ES with issues

  • docker-compose run --service-ports flask fetch_issues --state=open

To run the web service:

  • docker-compose build
  • docker-compose up