2018-08-20 19:46:06 +03:00
|
|
|
webcompat-search
|
|
|
|
|
=======================
|
|
|
|
|
|
|
|
|
|
Description
|
|
|
|
|
-------------
|
2019-11-26 18:03:26 +03:00
|
|
|
Utility to help with common tasks related to webcompat ES:
|
2018-08-20 19:46:06 +03:00
|
|
|
|
|
|
|
|
* 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](https://bit.ly/2OVfzXR).
|
|
|
|
|
|
|
|
|
|
Then setup the configuration using the following commands (in the toplevel of the project):
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
$ touch .env
|
2018-08-20 20:11:25 +03:00
|
|
|
$ echo "GITHUB_API_TOKEN = <GITHUB_API_TOKEN>" >> .env
|
2018-08-20 19:46:06 +03:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You also need to install `docker` and `docker-compose`.
|
|
|
|
|
|
|
|
|
|
* [docker](https://docs.docker.com/install/)
|
|
|
|
|
* [docker-compose](https://docs.docker.com/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`
|
