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.
The app is fully Dockerised. You just need docker to spin it up.
A production ready Docker image of the app is published as:
To get your own instance up, simply run:
docker run -it -p 8081:8080 ghcr.io/islamic-network/alquran.cloud:latest
You can now visit http://localhost:8081/ and start using it.
Please note that the Dockerfile included builds a production ready container which has opcache switched on and xdebug turned off, so you will only see your changes every 5 minutes if you are developing. To actively develop, change the FROM vesica/php72:latest
line to vesica/php72:dev
.
docker build . -t ghcr.io/islamic-network/alquran.cloud
. This will build an image with production dependencies only.docker run -it -p 8081:8080 -v $(pwd)/.:/var/www ghcr.io/islamic-network/alquran.cloud
to spin up the built image.composer install
to add development dependencies.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.
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.
You can also join the community at https://community.islamic.network/ or the Islamic Network Discord Server to discuss any of the apps or APIs @ https://discord.gg/FwUy69M.