marciovsena / Abibliadigital

ABibliaDigital.com.br is a RESTful API of the Holy Bible developed with Node.js + Express + MongoDB 🚀

► Table of Contents

• Why ?
• Setup
• Setup using Docker
• Fair use policy
• Documentation
• Credits and Thanks
• Contributing
• Contributor

Why ?

Application and site development is still a complex process for churches and religious organizations.

We know that creating unique content ends up competing with basic tasks such as making devotions, verses, comments, social networking nurture, and so many other day-to-day tasks available.

We believe that we can offer many of these services free of charge, with professional quality and focused on the word of God.

Setup

Dependencies

• Mongodb
• Yarn
• Redis
• Node.JS - I recommend using NVM

Steps

• Download this source code into a working directory.
• Install the requirements: yarn
• Create .env file:

MONGODB_URI=mongodb://localhost/abibliadigital
NODE_ENV="development"
SECRET_KEY=""
REDIS_URL="redis://127.0.0.1:6379"

• Run the server using the following command: yarn dev
• Visit localhost:3000/api/check to see the running api!

Setup using Docker

If you do not want to install Mongo, Redis, Node and Yarn, follow these steps.

Dependencies

• Docker
• Docker Compose

Steps

• Download this source code into a working directory. (Keep the directory name as "abibliadigital")
• Create .env file:

MONGODB_URI=mongodb://abibliadigital-mongo/abibliadigital
NODE_ENV="development"
SECRET_KEY=""
REDIS_URL="redis://abibliadigital-redis"

• Run the project using the following command: docker-compose up
• Visit localhost:3000/api/check to see the running api!

Rate Limit

• Without authentication the limit rate is 20 requests/hour/ip
• With user token, requests are unlimited (it's free)

Note: The limit rate was created to decrease the effectiveness of the attacks that we have been suffering from since 3/29/2020

Fair use policy

ABibliaDigital is free and open to use. The project is primarily an educational tool, and we will not tolerate denial of service attacks preventing people from learning.

Credits and Thanks

• @thiagobodruk for sharing various versions of the bible in json

Contributing

Contributions, issues and feature requests are very welcome. Please make sure to read the Contributing Guide before making a pull request.

Visit our trello board

Contributor

Created and maintained by:

Márcio Sena 💻 📖 🐛