EmojiCalculator

Emoji Calculator

Emoji Calculator is a prototype calculator, using emojis instead of regular math symbols, and created with Laravel 5.3 and Bootstrap v3.3.6.

How to set up and run it

We have firstly to clone the project locally: git clone https://github.com/thitami/EmojiCalculator.git

1. As soon as the clone process is finished, please run composer install so to install the project and all its dependencies.
2. Then, we need to copy .env.example file into the same directory (base dir) and rename it to .env. This file stores our configuration settings.
3. Next step is to generate a new unique application key by typing php artisan key:generate.
4. In our terminal we start a new server php artisan serve, which uses PHP's built-in server and by default listens to port :8000.

Then, we visit localhost:8000 in a browser and we are ready to use it!

Approach

When we hit localhost:8000 the following actions take place:

1. The Route::get('/','CalculatorController@homepage') route is matched in web.php
2. The CalculatorService is called to load the Operand symbols supplied in the .env file.
3. If the user has filled in (by mistake, or not so...) the same symbol for a different operation, then the defaults are loaded as defined in config/calculator.php file, and rendered in the view. We are using a basic layout, which is stored under resources/views/calculator/home.blade.php.
4. The user fills in numeric values in the Operand 1 and Operand 2 fields and hits the "=" button, where we post the form matching the route: Route::post('/calculate',['as' => 'calculator.getResult', 'uses' => 'CalculatorController@getResult']);
5. The user can also select a different value from the dropdown menu and the result will be automatically calculated on the server side and displayed in the results field.

Update Emojis

The emojis used by the calculator can be configured in the .env file:

 CALCULATOR_ADD_OPERAND = '👽'
 CALCULATOR_SUBTRACT_OPERAND = '💀'
 CALCULATOR_DIVIDE_OPERAND = '👻'
 CALCULATOR_MULTIPLY_OPERAND = '😱'

Please consider that if we set the same symbol for a different operation then the following defaults will be loaded:

     'add' => '👽',
     'subtract' => '💀',
     'multiply' => '👻',
     'divide' => '😱',

Tests

This project has a unit test coverage. PHPUnit tests can be found in tests/CalculationTest.php and get simply executed with the command phpunit from the base directory.

License

The Laravel framework is open-sourced software licensed under the MIT license.