gaignoux / cyberhawk-test Goto Github PK

need some content for this section

We've designed this task to try and give you the ability to show us what you can do and hopefully flex your technical and creative muscles. You can't show off too much here, show us you at your best and wow us!

To make things as simple as we could, we've opted to use Laravel Sail to provide a quick and convenient development environment, this will require you to install Docker Desktop before you can start the test. We've provided some more detailed instructions below in case this is your first time using Docker or Sail.

We'd like you to build an application that will display an example wind farm, its turbines and their components. We'd like to be able to see components and their grades (measurement of damage/wear) ranging between 1 - 5.

For example, a turbine could contain the following components:

• Blade
• Rotor
• Hub
• Generator

Don't worry about using real names for components or accurate looking data, we're more interested in how you structure the application and how you present the data.

Don't be afraid of submitting incomplete code or code that isn't quite doing what you would like, just like your maths teacher, we like to see your working. Just Document what you had hoped to achieve and your thoughts behind any unfinished code, so that we know what your plan was.

• Display a list of turbine inspections
• Each Turbine should have a number of components
• A component can be given a grade from 1 to 5 (1 being perfect and 5 being completely broken/missing)
• Use Laravel Models to represent the Entities in the task.

• Great UX/UI
• Use of React JS
• Use of Tailwind CSS
• Use of 3D
• Use of a web map technology in the display of the data
• Automated tests
• API Authentication
• Use of coding style guidelines (we use PSR-12 and AirBnb)
• Use of git with clear logical commits
• Specs/Plans/Designs

We're not too fussy about how you submit the task, providing it gets to us and we're able to run it we'll be happy however here are some of the ways we commonly see:

• Fork this repo, work and add us as a collaborator on your GitHub repo and send us a link
• ZIP the project and email it to us at [email protected]

As mentioned above we have chosen to make use of Laravel Sail as the foundation of this technical test.

• If you haven't already, you will need to install Docker Desktop.
• One that is installed your next step is to install this projects composer dependencies (including Sail).
  • This will require either PHP 8 installed on your local machine or the use of a small docker container that runs PHP 8 that can install the dependencies for us.
• If you haven't done so already copy the .env.example file to .env
  • If you are running a local development environment you may need to change some default ports in the .env file
    • We've already changed mysql to 33060 and NGINX to 81 for you
• It should now be time to start Sail and the task

https://laravel.com/docs/9.x/sail#installing-composer-dependencies-for-existing-projects

docker run --rm \
-u "$(id -u):$(id -g)" \
-v $(pwd):/var/www/html \
-w /var/www/html \
laravelsail/php81-composer:latest \
composer install --ignore-platform-reqs

First you need to run the command to raise the docker via Sail.

./vendor/bin/sail up -d

Then you will need to copy the .env.example to use the application.

./vendor/bin/sail cp .env.example .env

Then it will be necessary to run installation of composer packages, npm and run the data migration and generation for the database.

./vendor/bin/sail composer install

./vendor/bin/sail php artisan key:generate

./vendor/bin/sail php artisan migration

./vendor/bin/sail php artisan db:seed

./vendor/bin/sail cd resources/next && npm install

With that, the setup will be complete to run, but to access the frontend unfortunately you will have to access laravel resources, as it is integrated so that it is encompassed in a unique way.

cd resources/next && npm run dev

Now just access http://localhost:3000 and browse.

This project has unit and feature tests for the backend. To run just use the command below:

./vendor/bin/sail php artisan test

It also has tests implemented for the frontend, in this case to run you need to access the resources and run the following command:

./vendor/bin/sail cd resources/next && npm run test

Obs: Some implementations were not executed due to lack of time, but the idea was to allow each iteration with the component rate, a real-time update of the turbine.