brightcreations/exchange-rates

A Laravel package for fetching exchange rates from various sources.

v0.1.3 2025-06-10 07:25 UTC

Requires

• php: >=8.1
• illuminate/console: ^10.0 || ^11.0 || ^12.0
• illuminate/database: ^10.0 || ^11.0 || ^12.0
• illuminate/http: ^10.0 || ^11.0 || ^12.0
• illuminate/support: ^9.0|^10.0|^11.0|^12.0

Requires (Dev)

• orchestra/testbench: ^9.14
• pestphp/pest: ^2.36
• pestphp/pest-plugin-laravel: ^2.4
• vlucas/phpdotenv: ^5.6

MIT

• Bright Creations

• currency conversion
• laravel
• exchange rates

README

Overview

The Exchange Rates Service package provides a simple and efficient way to retrieve and manage exchange rates in your application. This package allows you to easily integrate exchange rate data into your project, making it ideal for e-commerce, financial, and other applications that require currency conversions.

Features

• Retrieves exchange rates from a reliable data source
• Caches exchange rates for improved performance
• Provides a simple and intuitive API for accessing exchange rates
• Supports multiple currencies and conversion scenarios

Installation

To install the Exchange Rates Service package, run the following command in your terminal:

composer require brightcreations/exchange-rates

Migrations

You can run the package migrations using the following command:

php artisan exchange-rates:migrate

Configuration (Optional)

To configure the package, publish the configuration file using the following command:

php artisan vendor:publish --provider="BrightCreations\ExchangeRates\ExchangeRatesServiceProvider"

Next, execute the migrations (if they haven't been executed yet):

php artisan migrate

Then, update the exchange-rates.php configuration file to suit your needs.

Usage

To retrieve exchange rates, use the ExchangeRateServiceInterface:

use BrightCreations\ExchangeRates\Contracts\ExchangeRateServiceInterface;

// get exchange rates of USD with all other currencies as a laravel collection
$exchangeRates = $service->getExchangeRates('USD');

You can inject the service into a constructor or resolve it using the resolve or app->make method. Here are examples of each approach:

Constructor Injection

use BrightCreations\ExchangeRates\Contracts\ExchangeRateServiceInterface;

class SomeClass {
    private $exchangeRateService;

    public function __construct(ExchangeRateServiceInterface $exchangeRateService) {
        $this->exchangeRateService = $exchangeRateService;
    }

    public function someMethod() {
        $exchangeRates = $this->exchangeRateService->getExchangeRates('USD');
        // Use $exchangeRates...
    }
}

Using resolve Method

use BrightCreations\ExchangeRates\Contracts\ExchangeRateServiceInterface;

$exchangeRateService = resolve(ExchangeRateServiceInterface::class);
$exchangeRates = $exchangeRateService->getExchangeRates('USD');
// Use $exchangeRates...

Using app->make Method

use BrightCreations\ExchangeRates\Contracts\ExchangeRateServiceInterface;

$exchangeRateService = app()->make(ExchangeRateServiceInterface::class);
$exchangeRates = $exchangeRateService->getExchangeRates('USD');
// Use $exchangeRates...

API Documentation

Coming soon...

Contributing

Contributions are welcome! Please submit a pull request or open an issue to report any bugs or suggest new features.

License

This package is licensed under the MIT License.

Author

Kareem Mohamed - Bright Creations Email: [e-mail]

Version

0.1.3