Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/islamic-network/alquran.cloud
Web App that powers https://alquran.cloud
https://github.com/islamic-network/alquran.cloud
islam php quran religion
Last synced: 3 months ago
JSON representation
Web App that powers https://alquran.cloud
- Host: GitHub
- URL: https://github.com/islamic-network/alquran.cloud
- Owner: islamic-network
- License: gpl-3.0
- Created: 2017-07-11T13:40:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-21T10:49:30.000Z (4 months ago)
- Last Synced: 2024-07-21T11:53:32.838Z (4 months ago)
- Topics: islam, php, quran, religion
- Language: HTML
- Size: 62.1 MB
- Stars: 311
- Watchers: 12
- Forks: 42
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Support: supporters.md
Awesome Lists containing this project
- awesome-Islam - Al Quran Cloud
README
## بِسْمِ اللهِ الرَّحْمٰنِ الرَّحِيْمِ
[](https://cairo.mamluk.net/teams/islamic-network/pipelines/alquran-cloud)
[](https://cloud.docker.com/u/vesica/repository/docker/islamicnetwork/alquran.cloud)
[](https://github.com/islamic-network/alquran.cloud/releases)
[](https://github.com/islamic-network/alquran.cloud/blob/master/LICENSE)
# 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 8.1
* Composer - See composer.json for other dependencies
* Slim Framework 4
* Bootstrap 3
* JQuery
* Bootstrap Multiselect
* 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:
* quay.io/islamic-network/alquran.cloud on Quay
* ghcr.io/islamic-network/alquran.cloud on Docker Hub
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.
### Build and Contribute
**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```.**
1. Clone this repository
2. Run ```docker build . -t ghcr.io/islamic-network/alquran.cloud```. This will build an image with production dependencies only.
3. Run ```docker run -it -p 8081:8080 -v $(pwd)/.:/var/www ghcr.io/islamic-network/alquran.cloud``` to spin up the built image.
3. Run ```composer install``` to add development dependencies.
6. Make sure you have internet connectivity so the app can connect to https://api.alquran.cloud.
7. Open your browser and browse to http://localhost:8081/.
8. 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.
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.