README.md

Static

Data for v-bible app

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• Getting Started
  • Prerequisites
  • Run Locally
• Usage
  • Scripts
  • Data Structure
• Roadmap
• Contributing
  • Code of Conduct
• License
• Contact
• Acknowledgements

🧰 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/static.git

Go to the project directory:

cd static

Install dependencies:

pnpm install

👀 Usage

Scripts

• generate-bible.js: Generate markdown from data

[!NOTE] > v-bible/backend is required to run this script

node ./scripts/generate-bible.js

• generate-version.js: Generate version metadata for versions folder.

node ./scripts/generate-version.js

• generate-search-index.js: Generate search index for fuse.js (Removed).

Data Structure

• calendar: Generated Liturgical calendars using v-bible/js-sdk.

• data/proper-names.json: Name translation from ktcgkpv.org, generated from v-bible/bible-scraper.

• liturgical: Liturgical data from The Lectionary for Mass (1998/2002 USA Edition) compiled by Felix Just, S.J., Ph.D., generated from v-bible/bible-scraper.

• versions: Generated bible using generate-bible.js.

🧭 Roadmap

• Add YOUCAT data.

👋 Contributing

Contributions are always welcome!

Please read the contribution guidelines.

📜 Code of Conduct

Please read the Code of Conduct.

⚠️ 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.

🤝 Contact

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

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

💎 Acknowledgements

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

• bible.com: bible.com website.
• biblegateway.com: biblegateway.com website.
• ktcgkpv.org: Nhóm Phiên Dịch Các Giờ Kinh Phụng Vụ website.
• The Lectionary for Mass (1998/2002 USA Edition): compiled by Felix Just, S.J., Ph.D.