Movie Catalog Application

Create a local development instance from scratch

• Prerequisites: installed locally docker and docker-compose
• Clone the repository: git clone git@github.com:staradzinau/app-movie-catalog.git
• Go down to the new directory: cd app-movie-catalog
• Create the env file from the template: cp .env.example .env
• Adjust variables in the .env file. At least, it's necessary to specify API key for TMDB, see TMDB_API_KEY
• Install Composer dependencies: docker run --rm -u "$(id -u):$(id -g)" -v "$(pwd):/var/www/html" -w /var/www/html laravelsail/php82-composer:latest composer install --ignore-platform-reqs. See details here
• Start Laravel Sail: ./vendor/bin/sail up -d, see details here
• Generate the key for the application: ./vendor/bin/sail artisan key:generate. Details
• Migrate your database: ./vendor/bin/sail artisan migrate
• [OPTIONAL] To create 1 default user, seed the app's database with the command ./vendor/bin/sail artisan db:seed. Email and password of the newly created user can be found/edited in the .env file, see USER_DEFAULT_EMAIL and USER_DEFAULT_PASSWORD
• Set up the frontend with 2 consecutive commands: ./vendor/bin/sail npm install and then ./vendor/bin/sail npm run dev
• The application is ready. Available by the APP_URL parameter value in the .env file (default). Mailpit email testing tool UI: http://localhost:8025/
• The details about movies and trendind list is updated automatically in the midnight. To trigger fetching details manually, please, execute the following console command (Sail-version): ./vendor/bin/sail artisan app:movie:trending-list:update {time-window}, where instead {time-window} you should use day or week to fetch data for corresponding time window

When the application is already deployed, following 2 commands would be enough to run the app: ./vendor/bin/sail up -d and ./vendor/bin/sail npm run dev

Technical details

During the development of the app, the TMDB official documentation has been used:

To simplify and formalize usage of TMDB, recommended library has been added, php-tmdb-api. Durig the development process, I haven't faced with API limits regarding frequency of requests

Additional packages were added:

• mkocansey/bladewind: useful collection of UI components
• barryvdh/laravel-debugbar: powerful debug bar
• laravel/breeze: official Laravel starter kit to support authentication features