Установка проекта

• Склонировать проект
• Запустить докер
• Запустить команду в корне проекта make install

Задача

Есть локации. В локациях хранилища. В хранилищах температура и определенный объем вместимости. Полное описание INFO.md

Нужно обязательно иметь

• Docker (v20+)
• Docker-Compose (v1.29+)
• GNU Make (v3+)

Желательно иметь свободные порты

Если порт занят, можно изменить порты в docker/docker-compose.override.yml и .env после команды make install.

• 80
• 443
• 5432
• 8080

Xdebug для PhpStorm

В PhpStorm > Preferences > Servers > +

• В Name нужно записать chat
• В Host нужно записать localhost
• Найти в Project files директорию проекта и прописать этой директории /var/www

Фильтрация в REST API

Используется библиотека spatie/laravel-query-builder

Примеры:

• Сортировка – /endpoint?sort=id
• Фильтрация – /endpoint?filter[name]=Fridge
• Подключение сущностей – /endpoint?include=subject

Хосты для работы с проектом

• http://localhost:8080 – для работы с БД
• http://localhost – для работы с REST API

Управление проектом

• make install – установка проекта через Docker
• make run – запуск проекта через Docker
• make stop – остановка проекта через Docker
• make php – перейти в контейнер с php через Docker

Возможности проекта, которые тебя заинтересуют

• Поднятие проекта написав всего лишь одну команду
• Запросы обрабатываются по архитектурному стилю REST API
• HTTP endpoint'ы поддерживают версионность, сортировку, фильтрацию и подключение сущностей
• Документация проекта, поддержка типизации и движения в ногу со временем PHP8\Laravel9
• Сидеры с фабриками для заполнения данными через faker
• Регистрация/Аутентификация/Восстановление/Изменение пользователя
• Локации городов и стран