Scrapes the arXiv API to index the papers!

The configuration is read from the following sources (in order of priority):

1. Environment variables explicitly set
2. .env file: placed in the root folder and named after the environment. Defaults to local.env (recommended)
3. Default values as defined in defaults.go

To define an environment file, you can duplicate the example.env file and adapt it to your settings.

If you want to keep several environment settings, you can save them under different names (i.e. local.env, dev.env, prod.env). When running a command, you can pass the corresponding environment name with the SCRAPER_ENVIRONMENT environment variable:

SCRAPER_ENVIRONMENT="prod" go run cmd/server/main.go

If SCRAPER_ENVIRONMENT isn't set, the config will read the settings from local.env by default.

All .env (except example.env) files are ignored by git to avoid exposing any credentials.

The repository exposes 1 command defined in the cmd folder.

To launch the scraper.

The scraper uses Mage for common development tasks, including building the binary. Mage is a pure Go library with no dependencies which offers a much easier API and syntax than the classic Makefile.

To install mage, run the following command:

go install github.com/magefile/mage

For production, you can use the prod target:

mage build:prod

To build a binary compatible with your local machine, you can use the local target:

mage build:local

To build a binary using the GOOS and GOARCH environment variables, you can run the following:

GOOS=linux GOARCH=arm64 mage build:env