The goal of this assignment is to demonstrate your familiarity with building an application that consumes a JSON API and displays aggregated data. There is no time limit for this assignment but we would advise time boxing the exercise to 1-3 hours. Even if you do not complete all of the tasks please submit the assignment.
You will be assessed on the design skills you demonstrate, rather than your proficiency with PHP as a language. Whilst the requirements are simple, you should aim to deliver a product that can be easily extended in the future. Feel free to provide notes with your submission explaining any decisions or shortcuts you deem appropriate.
This application is to connect to a live BigCommerce store via the V2 API. The application will consist of the following screens:
- A list of Customers, including the total number of orders they have placed
- A Customer Details screen that displays the Order History for that Customer and their Lifetime Value (defined as the total value of all of their orders)
Some skeleton code has been created for you to complete in the following folders:
app/Http/Controllers
resources/views
You are free, and encouraged, to create whatever additional models, services, etc you deem appropriate. If time allows, we would love you to include unit tests for your submission.
You will NOT be judged on the visual appearance of your application. Don't waste time making things pretty.
This application uses the Laravel framework which requires PHP >= 7.1 to run. If you do not already have PHP available on your machine, we suggest you use Homebrew to install it:
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install php
brew install php72-xdebug
You will also need to install Composer. Once setup, install dependencies:
composer install
Copy the included .env.example file:
cp .env.example .env
Open the newly created .env file and fill in the API_KEY field with the key supplied in the email along with this
assignment.
Before you can run the application, you need to generate an application key. You can do so by running:
php artisan key:generate
The Bigcommerce PHP API client is already installed as a
dependency and automatically initialised using the relevant fields in the .env file (see AppServiceProvider::boot).
When working correctly, you will see the store's time appear on the homepage. For instructions on accessing resources
using the API client, refer to the GitHub repository.
To serve the application:
php -S localhost:8000 -t public
To run the unit tests:
./vendor/bin/phpunit
Application logging can be found at
tail -f ./storage/logs/laravel.log
Your assignment should be submitted as a Git repository hosted on a service like GitHub, BitBucket or GitLab.
- .env is not committed, cause it contains some credentials. Please update API key and store url on your side before run.
- Added extra column named Detail on Customer page for easy access to CustomerDetail.
- Cache can be added to service call to avoid round trip(not yet).
- CustomerDetailPageTest/CustomerPageTest are just IT that are verifying happy cases with real data. This usually only fit for acceptance test. Usually I would create more isolated tests. But I'm not familiar with Laravel + PHP enough to come up with reasonably mocking and isolation.