arbell-php-test

Technical test done in May/June 2025

Created with

• Symfony 7.3
• Tabler 1.3.2
• API Platform 4.1

Also used

• MariaDB
• Symfony Profiler
• LexikJWTAuthenticationBundle for JWT (JSON Web Token) authentication

Branches

This project contains two main branches

• the web branch, which contains a site for basic User CRUD operations.
• the rest-api branch, which contains a REST API for basic User CRUD operations.

Composer packages

Run composer install to install all required packages

In the rest-api branch run php bin/console lexik:jwt:generate-keypair to generate the public and private keys used for signing JWT tokens.

Some technical details

• The project is done in Symfony to take advantage of their roles and permissions capabilities.
• Permissions are managed through the Profile entity. Each of them contains the role variable, that follows the ROLE_[NAME] convention used in Symfony. These are created using migrations. For more information about this, go to the Test data section.
• In the web branch, role names are managed through the RoleEnum enum to avoid any confusion.
• The database is MariaDB, the open source version of MySql. It is possible to switch to MySql, just update the url as explained later in this document.

User permissions

• Only authenticated users can access the CRUD.
• Only users with admin profile (ROLE_ADMIN) can send DELETE requests.

Database entity-relation diagram

Note: doctrine_migration_versions is an internal table used to keep track of executed migrations.

Environment variables

All envirnoment variables are managed using a .env file.

This proyect comes with an example .env. Symfony allows .env.[ENVIRONMENT_NAME] files, to store variables of a specific environment.

In this case we need to set up before running the project for the first time.

• APP_ENV to point which environment we are using. By default is set to dev.
• DATABASE_URL to connect with the MySql/MariaDB database. The value for MariaDB versions from 10.11.2 is mysql://[USER]:[PASSWORD]@[DB_URL]:[DB_PORT]/[DB_NAME]?serverVersion=10.11.2-MariaDB&charset=utf8mb4 where
  • USER is a valid database engine user, with at least reading and writing permissions
  • PASSWORD is the user password
  • DB_URL is the url used by the database engine. For local environments, the default is localhost
  • DB_PORT is the port used by the database engine for listening. For local environment, the default is 3306
  • DB_NAME is the database name

For MySql databases, use DATABASE_URL="mysql://[USER]:[PASSWORD]@[DB_URL]:[DB_PORT]/[DB_NAME].

For older MariaDB versions or other databases, go to Databases and the Doctrine ORM in the official Symfony documentation.

• The following keys belong to the lexik/jwt-authentication-bundle package used in the rest-api branch
  • JWT_SECRET_KEY defines the location of the secret key. Defaults to %kernel.project_dir%/config/jwt/private.pem.
  • JWT_PUBLIC_KEY defines the location of the public key. Defaults to %kernel.project_dir%/config/jwt/public.pem.
  • JWT_PASSPHRASE is required for token creation. This variable should be added automatically after generating the keys.

For more information about this package, go to its official GitHub repo.

Test data

Run php bin/console doctrine:database:create to create an empty database. Note that this command will fail if the database user does not have creating permissions.

Run php bin/console make:migrations:migrate to create all the database tables and fill them with test data.

Test data consists of the two profiles, one with role ROLE_ADMIN and other with role ROLE_USER, and one user, admin@example.com with admin capabilities and password test123.

Running locally

For local development, we can use the Symfony binary to run the local server.

Once the binary is installed, run php bin/console asset-map:compile --no-debug to compile all assets, followed by symfony server:start. If this last command does not work, check where the symfony binary is located. For Linux systems the default location is $HOME/.symfony/bin.

By default, the server is available at http://localhost:8000.

Screenshots

Web

Home page

Without being logged in

Logged in

Login

List

Creation

Details

Edit

Deletion

Access denied

User deletion denied

Mobile (iPad 810x1080)

Examples (done with Imsomnia)

Requests available at insomnia_api_requests.yml

Login (get authorization token)

Set authorization token

Get all profiles

Get all users

Creation new user (with Faker)

Get one user in particular

Edit a specific user

Edit a specific user - email validaton error

Delete a specific user

Authorization

Delete user - access denied for user with ROLE_USER profile

Get all users - access denied for unauthenticated user