Skip to content

v-bible/static

Repository files navigation

Static

Data for v-bible app

contributors last update forks stars open issues license


📔 Table of Contents

🧰 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

🧭 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.

License: CC BY-NC-SA 4.0.

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:

About

v-bible static bible data hosting

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published