Skip to content

quran/quran.com-api

This branch is 1 commit ahead of, 44 commits behind do-staging.

Folders and files

NameName
Last commit message
Last commit date
Feb 28, 2022
Dec 22, 2021
Mar 23, 2024
Feb 28, 2022
Mar 23, 2024
Sep 1, 2023
Dec 31, 2017
Aug 17, 2016
Mar 15, 2023
Apr 21, 2016
Mar 15, 2023
Jan 9, 2022
Oct 22, 2017
Jan 12, 2015
Mar 31, 2016
Jan 11, 2021
Jan 24, 2017
Sep 26, 2020
Sep 23, 2020
Feb 28, 2022
Jun 2, 2021
Feb 28, 2022
Feb 28, 2022
Apr 4, 2024
Apr 4, 2024
Apr 10, 2018
Sep 30, 2016
Oct 22, 2017
Sep 1, 2023
Apr 10, 2018
Oct 12, 2015
Dec 31, 2017
Apr 10, 2018
Dec 31, 2017
Oct 28, 2017
Dec 31, 2017
Dec 31, 2017
Aug 4, 2022
Aug 4, 2022
Aug 4, 2022
Oct 28, 2017
Apr 22, 2021
Apr 22, 2021
Mar 15, 2023
Aug 4, 2022

Repository files navigation

Code Climate

Requirements

  • Rails 5.0.1
  • Elasticsearch 5.0.1
  • Ruby 3.1.0

Installations

Gems:

bundle install

Elasticsearch: See config/elasticsearch/README.md

Postgresql:

This is the best way if you're on mac: http://postgresapp.com/ But to install the pg gem, you will have to do:

gem install pg -- --with-pg-config=/Applications/Postgres.app/Contents/Versions/9.4/bin/pg_config

If you decide to install postgres with homebrew (brew install postgresql) you should not have this problem.

Why should you use the app? You have quick commandline tools such as: The following tools come with Postgres.app:

PostgreSQL: clusterdb createdb createlang createuser dropdb droplang dropuser ecpg initdb oid2name pg_archivecleanup pg_basebackup pg_config pg_controldata pg_ctl pg_dump pg_dumpall pg_receivexlog pg_resetxlog pg_restore pg_standby pg_test_fsync pg_test_timing pg_upgrade pgbench postgres postmaster psql reindexdb vacuumdb vacuumlo

See: http://postgresapp.com/documentation/cli-tools.html

Database

It's private, we will not share complete dump. If you need mini version for contributing to quran.com, please join our slack channel and ask one of project's collaborator for access.

Usage

http://localhost:3000/api/v4/chapters/1

Documentation

V4 docs: https://api-docs.quran.com/docs/category/quran.com-api deprecated V4 docs: https://quran.api-docs.io/v4/

Note that v3 is no longer being extended or fixed. For v3 -> v4 migration guide see: https://quran.api-docs.io/v4/getting-started/api-v3-v4-migration-guide

Community

Join Quran.com community here https://quran-community.herokuapp.com

Tests

We have put some time to test the api and the search. You may need to have elasticsearch running in order for the tests to go through search although we should be looking for an elasticsearch mock.

Simply run:

rspec