:notebook_with_decorative_cover: Table of Contents

• About the Project
  • Environment Variables
• Getting Started
  • Prerequisites
  • Run Locally
• Usage
• Contributing
  • Code of Conduct
• License
• Contact

:star2: About the Project

:key: Environment Variables

To run this project, you will need to add the following environment variables to your .env file:

• App configs:
  • LOG_LEVEL: Log level.
  • LOG_FILE_PATH: (Optional) File path to save logs. Default to scraper.log.

E.g:

# .env
LOG_LEVEL=info

You can also check out the file .env.example to see all required environment variables.

:toolbox: Getting Started

:bangbang: Prerequisites

• This project uses pnpm as package manager:

  npm install --global pnpm

:running: Run Locally

Clone the project:

git clone https://github.com/v-bible/digivatlib-scraper.git

Go to the project directory:

cd digivatlib-scraper

Install dependencies:

pnpm install

Build the project:

pnpm build

:eyes: Usage

USAGE
  digivatlib-scraper [--outDir value] [--height value] [--width value] [--toPdf] <args>...
  digivatlib-scraper --help
  digivatlib-scraper --version

Digital Vatican Library Scraper

FLAGS
     [--outDir]           Output directory. Default to "./output/<document-name>"
     [--height]           Image height. Default to 720 pixels
     [--width]            Image width
     [--toPdf/--noToPdf]  Convert downloaded images to a single PDF file
  -h  --help              Print help information and exit
  -v  --version           Print version information and exit

ARGUMENTS
  args...  List of document names to scrape from Digivatlib (e.g., "Cicognara.VI.319", "Borg.ill.19")

Example:

pnpm build && ./dist/cli.js --outDir ./my-output --height 800 --toPdf Cicognara.VI.319 Borg.ill.19

:wave: Contributing

Contributions are always welcome!

Please read the contribution guidelines.

:scroll: Code of Conduct

Please read the Code of Conduct.

:warning: License

This project is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) License.

.

See the LICENSE.md file for full details.

:handshake: Contact

Duong Vinh - @duckymomo20012 - [email protected]

Project Link: https://github.com/v-bible/digivatlib-scraper.