# webcompat-search

**Repository Path**: mirrors_mozilla/webcompat-search

## Basic Information

- **Project Name**: webcompat-search
- **Description**: Search HTTP API for webcompat issues
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

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](https://bit.ly/2OVfzXR).

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](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`