iamkarsoft/kudi

A laravel package to convert currency to/from ghana cedis(GHS)

v0.2.1 2022-05-27 19:30 UTC

Requires

• php: ^7.0|^7.3|^8.0|^8.1

Requires (Dev)

• orchestra/testbench: ^6.20
• phpunit/phpunit: ^9.5

MIT

• Kofi Ramos Amoussou

README

A Laravel package to convert currencies to/from Ghana Cedis(GHS).

Installation

composer require iamkarsoft\kudi

Publishing config files

php artisan vendor:publish --provider="Iamkarsoft\Kudi\KudiServiceProvider" --tag="config"

Providers

You'll need to create accounts and get your api keys from the providers you wish to use.

• For Free Currency API Account and add KUDI_API_KEY=Your_API_KEY and KUDI_API_PROVIDER="free currency api" in your .env file
• For Currency Data Api from Api layer Account and add KUDI_API_KEY=Your_API_KEY and KUDI_API_PROVIDER="currency data api" in your .env file
• For Fixer Api from Api Layer Account and add KUDI_API_KEY=Your_API_KEY and KUDI_API_PROVIDER="fixer api" in your .env file

Usage

1. In a controller

Converting From Any Currency to GHS

 Kudi::convertFrom('USD',20); 

// assigning result to a variable
$converted= Kudi::convertFrom('USD',20); 

Converting to Any Currency from GHS

 Kudi::convertTo('EUR',10000);

// assigning result to a variable
 $converted = Kudi::convertTo('EUR',10000);

1. Using it in a blade template

// to get the value
{{$converted['value']}} 

// to get the currency
{{$converted['currency']}}

// to get the provider you're using
{{$converted['provider']}}

Response

If your request is successful. your response will look something like the following:

// converting from USD to Ghana Cedis
{
"value": "7.75",
"currency": "GHS",
"provider": "currency data api"
},

// converting to Euros
{
"value": "120.55",
"currency": "EUR",
"provider": "currency data api"
}