Al Quran Cloud

This is the code you see deployed on https://alquran.cloud. This documentation explains how you can get setup to deploy your own instance and contribute code.

Technology Stack and Requirements

PHP 7.2
Composer - See composer.json for other dependencies
Slim Framework
Bootstrap 3
JQuery
Bootstrap Multiselect
Media Elements JS
Docker

Getting Started

Running the App

The app is fully Dockerised. You just need docker to spin it up.

A production ready Docker image of the app is published as vesica/alquran.cloud on Docker Hub (https://hub.docker.com/r/vesica/alquran.cloud/).

To get your own instance up, simply run:

docker run -it -p 8081:8080  vesica/alquran.cloud:latest

You can now visit http://localhost:8081/ and start using it.

Build and Contribute

Clone this repository
Run docker build . -t vesica/alquran.cloud. This will build an image with production dependencies only.
Run docker run -it -p 8081:8080 -v ($pwd)/.:/var/www vesica/alquran.cloud to spin up the built image.
Run composer install to add development dependencies.
Make sure you have internet connectivity so the app can connect to https://api.alquran.cloud.
Open your browser and browse to http://localhost:8081/.
Any changes you make will be synced to the Docker container. You just refresh the page in the browser to see them.

Scaling and Sizing

This app takes 15 MB per apache process / worker and is set to have a maximum of 20 Apache workers.

A single instance should be sized with a maximum of 512 MB RAM, after which you should scale it horizontally.

Contributing Code

You can contribute code by raising a pull request.

There's a backlog of stuff under issues for things that potentially need to be worked on, so please feel free to pick something up from there or contribute your own improvements.