Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/omarciovsena/abibliadigital
A RESTful API for Bible
https://github.com/omarciovsena/abibliadigital
api bible bibleapi hacktoberfest restfull-api
Last synced: 7 days ago
JSON representation
A RESTful API for Bible
- Host: GitHub
- URL: https://github.com/omarciovsena/abibliadigital
- Owner: omarciovsena
- License: bsd-2-clause
- Created: 2018-11-25T03:20:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-28T01:46:05.000Z (14 days ago)
- Last Synced: 2024-06-28T02:46:56.909Z (14 days ago)
- Topics: api, bible, bibleapi, hacktoberfest, restfull-api
- Language: JavaScript
- Homepage: http://www.abibliadigital.com.br
- Size: 6.58 MB
- Stars: 723
- Watchers: 25
- Forks: 114
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- docsify-awesome-stars - omarciovsena/abibliadigital - A RESTful API for Bible (JavaScript)
- awesome-jekyll - omarciovsena/abibliadigital - A RESTful API for Bible (JavaScript)
- awesome-stars - omarciovsena/abibliadigital - A RESTful API for Bible (JavaScript)
README
ABibliaDigital.com.br is a RESTful API of the Holy Bible developed with Node.js + Express + MongoDB 🚀
## ► Table of Contents
- [Why ?](#why-)
- [Setup](#setup)
- [Setup using Docker](#setup-using-docker)
- [Fair use policy](#fair-use-policy)
- [Documentation](https://github.com/omarciovsena/abibliadigital/blob/master/DOCUMENTATION.md)
- [Credits and Thanks](#credits-and-thanks)
- [Contributing](#contributing)
- [Contributor](#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](https://www.mongodb.com/)
- [Yarn](https://yarnpkg.com/en/)
- [Redis](https://formulae.brew.sh/formula/redis)
- Node.JS - I recommend using [NVM](https://github.com/nvm-sh/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](https://docs.docker.com/install/)
- [Docker Compose](https://docs.docker.com/compose/install/)
### Steps
- Download this source code into a working directory. (Keep the directory name as "abibliadigital")
- 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](https://github.com/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](/CONTRIBUTING.md) before making a pull request.
Visit our [trello](https://trello.com/b/VPGRzM36/biblieapi) board
## Contributor
Created and maintained by:
| [
Márcio Sena](https://github.com/omarciovsena)
[💻](https://github.com/omarciovsena/abibliadigital/commits?author=marciovsena "Code") [📖](https://github.com/omarciovsena/abibliadigital/commits?author=omarciovsena "Documentation") [🐛](https://github.com/omarciovsena/abibliadigital/issues?q=author%3Aomarciovsena "Bug reports")
| :---: |