Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abdeltwabmf/next-prayer
Islamic prayer reminder for Unix status bars.
https://github.com/abdeltwabmf/next-prayer
bash cpp docker hacktoberfest hacktoberfest2022 linux makefile muslim-prayer-times prayer-times prayertimes python3 salat-timings
Last synced: 5 days ago
JSON representation
Islamic prayer reminder for Unix status bars.
- Host: GitHub
- URL: https://github.com/abdeltwabmf/next-prayer
- Owner: AbdeltwabMF
- License: gpl-3.0
- Created: 2021-09-08T01:57:17.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-02T00:00:38.000Z (over 1 year ago)
- Last Synced: 2024-08-04T04:02:17.769Z (3 months ago)
- Topics: bash, cpp, docker, hacktoberfest, hacktoberfest2022, linux, makefile, muslim-prayer-times, prayer-times, prayertimes, python3, salat-timings
- Language: C
- Homepage:
- Size: 2.75 MB
- Stars: 51
- Watchers: 2
- Forks: 10
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
Next Prayer
Islamic prayers reminder for Linux status bar
---
## Installation
### 1. Arch-based distributions
```bash
yay -S next-prayer
```
### 2. Build from source
```bash
git clone https://github.com/abdeltwabmf/next-prayer.git
cd next-prayer
make all install
```
### 3. Docker image
1. Use [**_Docker Hub_**](https://hub.docker.com/r/abdeltwabmf/next-prayer) image by running the following commands:
```bash
docker pull abdeltwabmf/next-prayer
docker tag abdeltwabmf/next-prayer next-prayer
docker run --rm next-prayer next-prayer --version
```
2. Build it yourself by running the following commands:
```bash
git clone https://github.com/abdeltwabmf/next-prayer.git
cd next-prayer
docker build -t next-prayer .
docker run --rm next-prayer next-prayer --version
```
#### Configuration
1. After updating your configuration file save it locally and run the following command to fetch API data:
```dockerfile
docker run --rm -v /path/to/your/config:/home/nextprayer/.config/next-prayer/np_config.py -v /path/to/your/data:/home/nextprayer/.local/share/next-prayer next-prayer np_fetch.py
```
2. Afterword run the following command:
```dockerfile
docker run --rm -v /path/to/your/data:/home/nextprayer/.local/share/next-prayer next-prayer next-prayer [options...]
```
---
## :thinking: Usage
```shell
Usage: next-prayer [options...]
Options:
--help Display this help message.
--version Version name.
--next Next prayer time.
--all All timings.
--prev Previous prayer time.
--left Time left to next prayer.
--elapsed Elapsed time since last prayer.
--adhan True if adhan is playing now.
--hijri Hijri date.
--hybrid The elapsed time since the previous prayer as far as the elapsed time <= THRESHOLD.
```
Use `next-prayer` options with _docker_ as follows:
docker run --rm next-prayer next-prayer [options...]
---
## Setup (Status bar)
Here are some examples how to setup the status bar with next-prayer:
[**_1. dwmblocks_**](https://github.com/torrinfail/dwmblocks)
:star2: Add this 4-element Block to the blocks[] array in your config.h.
```c
static const Block blocks[] = {
/*Icon*/ /*Command*/ /*Update Interval*/ /*Update Signal*/
{"🕌 ", "next-prayer --hybrid", 29, 0}
}
```
[**_2. i3blocks_**](https://github.com/vivien/i3blocks)
:star2: Add this section to your i3blocks config file.
```code
[next-prayer]
command=next-prayer --hybrid
interval=29
label=🕌
color=#FF8105
border=#FF8105
border_top=1
border_right=0
border_bottom=0
border_left=0
```
:eyes: If you're using the docker version Add `docker run --rm next-prayer` at the very beginning of your command.
---
## :hatching_chick: Contributors
Abd El-Twab M. Fakhry
Mazen Saad
Mustafa Amer
---
## :warning: License
Licensed under the [GPL-v3 License](LICENSE).
