salat-times
v1.0.3
Published
**salat-time CLI** is a simple command-line tool that fetches and displays daily Islamic prayer times for any city in Nigeria. Powered by the Aladhan API, this tool helps Muslims stay updated on prayer schedules conveniently from their terminal.
Readme
salat-time CLI
salat-time CLI is a simple command-line tool that fetches and displays daily Islamic prayer times for any city in Nigeria. Powered by the Aladhan API, this tool helps Muslims stay updated on prayer schedules conveniently from their terminal.
Features
- Fetch prayer times for any city in Nigeria.
- User-friendly interface with color-coded output.
- Default city set to Lagos, Nigeria (customizable).
Installation
Clone the repository or install via npm:
npm install -g salat-timesMake sure you have Node.js (v16 or higher) installed.
Usage
Basic Usage
Run the following command in your terminal:
salat-times --city <city-name>Example
$ salat-times --city LagosOutput:
Prayer Times for Lagos:
Fajr: 05:20
Dhuhr: 12:35
Asr: 15:50
Maghrib: 18:10
Isha: 19:45Default City
If you don’t provide a city, the tool defaults to Lagos, Nigeria:
$ salat-timesOptions
| Option | Description | Default |
|-------------------|---------------------------------|-----------------|
| -c, --city | Specify the city name. | Lagos |
| -V, --version | Display version information. | |
How It Works
- The tool uses the Aladhan API to fetch prayer times.
- Input your city using the
--cityoption. - Outputs prayer times formatted neatly in the terminal.
Development Setup
Clone the repository:
git clone https://github.com/your-username/salat-times-cli.git cd salat-times-cliInstall dependencies:
npm installRun the tool locally:
node index.js --city <city-name>
Contribution
Contributions are welcome! Here's how you can help:
- Fork the repository.
- Create a new branch:
git checkout -b feature-name - Commit your changes:
git commit -m "Add a feature" - Push to your branch:
git push origin feature-name - Open a pull request.
