gilmarbrito / mb-challenge

MB challenge repo

MB test

Candidate challenge for PHP Developer position at MB.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installation

Install Using Docker Compose

Repository

https://github.com/GilmarBrito/mb-challenge

Prerequisites

• Docker version 25.0.2 and later
• Docker Compose version v2.24.5 and later

Docker Environment

• PHP v8.3.2
• Nginx Latest
• MySQL v8.3.0

Steps

Step 1 - Clone this repo:

git clone [email protected]:GilmarBrito/mb-challenge.git

or

git clone https://github.com/GilmarBrito/mb-challenge.git

Step 2 - Open folder:

cd mb-challenge

Step 3 - Run the containers:

docker compose up --build -d

Step 4 - Install backend dependencies:

docker compose exec php-service composer install && composer dump-autoload --optimize

Step 5 - Install frontend dependencies:

docker compose exec php-service npm install && npm run build

Step 6 - Run Laravel config commands:

docker compose exec php-service php artisan key:generate && php artisan optimize:clear

Step 7 - Run Laravel migrations and seeders:

docker compose exec php-service php artisan migrate --seed

Execute (After run up docker containers)

• http://localhost:8080
• User: [email protected]
• Password: secret

Others command that you can run

Check code style

docker compose exec php-service composer check-style

Run tests

docker compose exec php-service composer run-tests

Run static analise

docker compose exec php-service composer run-analise

• PS.:
  • To run the application, port 8080 on localhost (127.0.0.1) must be free.
  • The .env was posted with the api-key just to facilitate installation by the evaluator. We do not recommend this practice.
  • The user and password data was posted just to facilitate installation by the evaluator. We do not recommend this practice.
  • The api-key was created precisely for this challenge, so it can be shared in the repository.
  • The tests do not have complete coverage. The main purpose here is to demonstrate knowledge. I considered doing that because this is just a challenge made in my free time.