webcompat-search/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.

• docker
• 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