adedayomatt / curacel-fullstack-php-test Goto Github PK

Same way you would install a typical laravel application.

composer install

npm install

php artisan serve

The UI is displayed on the root page

Don't forget to run npm run dev after modifying the vue component.

Alternatively to the regular setup above, the application can be run a more controlled environment using Docker. This is to ensure all the necessary tools needed for the development are available and to maintain environment consistency. If you are not interested in running it in docker you can skip to post setup section

git pull --recurse-submodules

cd laradock

copy .env.example .env

The application is developed in php7.4 and node 16.13.2 environment, it is recommended to also run it in a similar environment to avoid dependency conflicts. These versions can be adjusted in the laradock/.env file by updating the following keys:

PHP_VERSION=7.4
WORKSPACE_NODE_VERSION=16.13.2

We need nginx, mysql and workspace containers running. The workspace container already contains necessary softwares requires to successfully run a Laravel project, e.g PHP CLI, Composer, Node, e.t.c.

docker-compose up -d nginx mysql workspace

docker-compose exec workspace bash

Continue running the following commands In the workspace bash...

composer install

php artisan key:generate

php artisan migrate

php artisan db:seed --class=HmoSeeder

npm install

npm run dev

In app .env file, set the following...

DB_CONNECTION=mysql
DB_HOST=mysql
DB_DATABASE=default
DB_USERNAME=root
DB_PASSWORD=root

Mailing credentials should be provided in the env for email notification to work. You can use a credential from Mailtrap for testing.

Actions such as batching orders, processing orders and sending notifications are queued, the queue worker needs to be up to pick and complete those actions.

php artisan queue:work --queue=notifications,batchers,orders

There is a feature test for creating order via api and unit tests for batching order by encounter date and by order create date.

php artisan test

For the frontend in vuejs, tests are available for the button component and widgets for submitting order using jest

npm run test