Bible Scraper

Scrape Bible

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

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

🌟 About the Project

🎯 Features

• Scrape bible from biblegateway.com and bible.com. Current supports:
  • Verses (with poetry).
  • Footnotes.
  • Headings.
  • References.
  • Psalm metadata (like author, title, etc.).
• Progress logging.
• Save to Postgres database.

🔑 Environment Variables

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

• App configs:

  DB_URL: Postgres database connection URL.

  LOG_LEVEL: Log level.

E.g:

# .env
DB_URL="postgres://postgres:postgres@localhost:5432/bible"
LOG_LEVEL=info

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

🧰 Getting Started

‼️ Prerequisites

This project uses pnpm as package manager:

npm install --global pnpm

Playwright:

Run the following command to download new browser binaries:

npx playwright install

🏃 Run Locally

Clone the project:

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

Go to the project directory:

cd bible-scraper

Install dependencies:

pnpm install

Setup Postgres database using Docker compose:

docker-compose up -d

Migrate the database:

pnpm prisma:migrate

Generate Prisma client:

pnpm prisma:generate

👀 Usage

Note

To prevent the error net::ERR_NETWORK_CHANGED, you can temporarily disable the ipv6 on your network adapter:

sudo sysctl -w net.ipv6.conf.all.disable_ipv6=1
sudo sysctl -w net.ipv6.conf.default.disable_ipv6=1

Scrape bible (from biblegateway.com):

npx tsx ./src/biblegateway/main.ts

Scrape bible (from bible.com):

npx tsx ./src/bibledotcom/main.ts

Note

For the bible.com script, it doesn't use the local version code, which may vary for different languages. For example, in Vietnamese language, version "VCB" has local code is "KTHD".

👋 Contributing

Contributions are always welcome!

📜 Code of Conduct

Please read the Code of Conduct.

❔ FAQ

• Question 1

  • Answer 1.

• Question 2

  • Answer 2.

⚠️ License

Distributed under MIT license. See LICENSE for more information.

🤝 Contact

Duong Vinh - @duckymomo20012 - tienvinh.duong4@gmail.com

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

💎 Acknowledgements

Here are useful resources and libraries that we have used in our projects:

• Bible.com: Bible.com website.
• BibleGateway.com: BibleGateway.com website.