README.md

GitHub archive keyword API

How to start the project

Copy the .env file

cp .env.dist .env

Change the contents

Start the docker env

docker-compose -p gha-keyword up --build

Fill the APP key

wait to see that the first composer install is done

docker-compose -p gha-keyword exec php-7.4-nginx php artisan key:generate

Migrate the database

docker-compose -p gha-keyword exec php-7.4-nginx php artisan migrate

Ingest data

Today

docker-compose -p gha-keyword exec php-7.4-nginx php artisan ingest --today

A date

docker-compose -p gha-keyword exec php-7.4-nginx php artisan ingest --date=2020-01-25

Run the tests

docker-compose -p gha-keyword exec php-7.4-nginx composer run test

Browse the results

http://localhost:8085/search

Try the API to get some data

curl -H 'Accept: application/json' http://localhost:8085/api/search/stats?searchDate=2020-01-25

A screenshot