A Simple app that convert currencies from USD to EUR and vice-versa.
The app goal is to build a simple P2P wallet (Pay) system.
There are two registered users with a single currency based wallet. User
A has a USD and user B has a EUR wallet. User A can send any amount of money
to user B in USD currency. This USD amount will be converted to EUR and
transferred to user B wallet. In the meantime, a confirmation email will be sent to
user B.
You will find detailed requirements below. To be successful you don’t have to follow
them strictly. Invest reasonable time depending on your free time and don’t worry if
you can’t finish it all. Focus on the quality of your code, not on the number of
tasks. Make it readable, expandable and production-ready. Make sure you deal
with possible errors etc. Please read the requirements and additional
requirements carefully.
Feel free to ask any questions. Write down any significant problems you
encountered. Let us know how you solved them or how you would tackle them if you
had more time.
❖ Use Laravel / Lumen RESTful
API to develop this currency conversion application.
❖ Using Passport authentication feature to make API secure.
❖ Each user will have only one single currency based wallet.
❖ The system should also display the following stats:
❏ User who used most conversion.
❏ The total amount converted for a particular user.
❏ Show the third highest amount of transactions for a particular user
(must use subquery).
❖ Have to calculate and store data in the database to show stats properly.
❖ Prefer to use a MySQL database for storing user’s data and stats.
❖ For interface design using any appropriate responsive design template.
❖ In the backend, using an external API to get the currency rates (https://openexchangerates.org).
❖ Trying to use any design pattern with the latest Laravel features.
❖ Trying to follow SOLID design principles for your coding.
❖ Make sure to write a PHPUnit test for the application.
❖ Currency rates APIs:
❏ https://openexchangerates.org
- "php": "^7.4|^8.0".
- "laravel/framework": "^8.56".
1. Passport Generated Token
- token validation checking and responses through middleware
2. Database migration
3. Authentication
- all possible responses
- Validation for login
- all possible responses for invalid login and signup
4. https://openexchangerates.org api integration
5. Currency Conversion
6. Reports
* System diagram:
* Database diagram:
- By default users are created when we run the command `php artisan db:seed`.
- User will log into the system and convert currency to another user.
* System will check all validations and request to `https://openexchangerates.org` with app id set on `config/currency_rate.php` to get all updated currency rate based on `USD`.
- User will see the reports without authentication.
- Json file of postman api collection in the root directory named `currency convert.postman_collection.json`
Project setup details are described below step by step: The front end project for this project is https://github.com/zrshishir/currency-conversion-frontend. First, follow these steps then front end steps
1. Download or clone the project from [currency conversion]([email protected]:zrshishir/currency-conversion.git)..
2. Go to the project's root directory and run the command `composer install` or `composer update`.
3. After successfully composer updation set up your database credentials on .env file.
4. Set your app_id for currency rates api from https://openexchangerates.org.
5. Set you smtp email configuration on .env file from https://mailtrap.io/ to send confirmation email
6. Run the command `php artisan migrate`
7. Run the command `php artisan passport:install`
8. Run the command `php artisan passport:key`
9. Run the command `php artisan db:seed`
10. If you need to rollback the database, just run the command `php artisan migrate:rollback`
11. If you are using LEMP stack then follow proper steps [here](https://www.digitalocean.com/community/tutorials/how-to-install-linux-nginx-mysql-php-lemp-stack-ubuntu-18-04) and if you are using other then run the command `php artisan serve` to get the domain name or service url that will have to be assigned in the [frontend code]([email protected]:zrshishir/) `/src/api/product-frontend.js` ROOT_URL const.
The working procedure is described below with screenshots:
1. To install this project you will have composer installed. You can install this project two ways
- Download the zip file from the repository and extract it on your pc
- clone the project using git and the command is `git clone [email protected]:zrshishir/currency-conversion.git`.
2. Go to the project's root directory
3. run the command `composer update` or `composer install` and configure your database on .env file
4. api credentials for https://openexchangerates.org to get updated currency rates. To do so, edit 'config/currency_rate.php'
5. edit your .env file to complete smtp mail server setup
6. Run the command `php artisan migrate`
7. Run the command `php artisan passport:install`
8. Run the command `php artisan passport:key`
9. Run the command to seed database `php artisan db:seed`
10. Run the command `php artisan serve` and use this link on the postman url
Some screenshots of the project postman api: As I use LEMP stack for my local server environment, I have used domain name in the url
you can use localhost or ip. I have attached postman json file for the project. You can use it also.
1. Login field validation response
2. Login email validation response
3. Login user not exist response
4. Login successfull response
5. Logout successfull response
6. Currency Conversion: Response for invalid receiver ID
7. Currency Conversion: Response for checking balance availability
8. Currency Conversion: Response for invalid app id for open exchange rate api call
9. Currency Conversion: Response for successfully currency conversion
10. Currency Conversion: Confirmation email on mailtrap.io inbox
11. Currency Conversion: Open Exchange Rate API Status `https://openexchangerates.org/`
12. Transaction: Transaction api with data
13. Transaction: Transaction api without data
14. Currency Conversion Report: Reports on most conversion and total amount converted for a particaular receiver
15. Currency Conversion Report: Reports on third highest amount of transactions for a particular user
16. Running test script
