salat-times

1.0.3 • Public • Published

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

  1. Clone the repository or install via npm:

    npm install -g salat-times
  2. Make 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 Lagos

Output:

Prayer Times for Lagos:
Fajr: 05:20
Dhuhr: 12:35
Asr: 15:50
Maghrib: 18:10
Isha: 19:45

Default City

If you don’t provide a city, the tool defaults to Lagos, Nigeria:

$ salat-times

Options

Option Description Default
-c, --city Specify the city name. Lagos
-V, --version Display version information.

How It Works

  1. The tool uses the Aladhan API to fetch prayer times.
  2. Input your city using the --city option.
  3. Outputs prayer times formatted neatly in the terminal.

Development Setup

  1. Clone the repository:

    git clone https://github.com/your-username/salat-times-cli.git
    cd salat-times-cli
  2. Install dependencies:

    npm install
  3. Run the tool locally:

    node index.js --city <city-name>

Contribution

Contributions are welcome! Here's how you can help:

  1. Fork the repository.
  2. Create a new branch:
    git checkout -b feature-name
  3. Commit your changes:
    git commit -m "Add a feature"
  4. Push to your branch:
    git push origin feature-name
  5. Open a pull request.

Readme

Keywords

none

Package Sidebar

Install

npm i salat-times

Weekly Downloads

5

Version

1.0.3

License

ISC

Unpacked Size

18.4 kB

Total Files

6

Last publish

Collaborators

  • ibrahimabdulquadri101