Morele.net recruitment task

About The Project

Movie search engine made as a recruitment task

Built With

• PHP
• Symfony
• Docker
• Compose

Getting Started

Installation

Follow these simple steps

Clone API repository

git clone git@github.com:RyuuKodex/movie-search-engine.git

Building environment for development

First things first you have to copy the development environment template. It' located in .devcontainer, I'd reccomend to leave it there and create a symbolic link.

ln -s ./etc/envs/compose.dev.yaml .
mv compose.dev.yaml compose.override.yaml

Now we'll use docker to build our image locally, with local architecture:

docker compose build

It may take few seconds, when it's completed proceed with running the container:

docker compose up --detach

Remember that you have installed the vendors in an image, however while creating container you've replaced built app folder with empty one (repository has no vendor folder intentionally). So, we have to proceed once again with app configuration:

docker compose exec app bash -ce "
    composer install
    chown -R $(id -u):$(id -g) .
  "

Now you're all set, you can visit the localhost with port 80, you should see the Symfony default application web page.

Endpoint

  GET /api/movies/search?algorithm=<algorithm>

  List of algorithms:
  - random
  - startsWithW
  - moreThanOneWord

Commands

Start the project

docker compose up -d

Connect to app container

docker compose exec app bash

Stop project

docker compose down --remove-orphans

CS-fixer

docker compose exec app composer run-lint-fix

PHP-Stan

docker compose exec app composer run-phpstan-analysis

Testing

Unit

Use the command below to run unit tests.

docker compose exec app composer run-unit-tests