Реализовано: Docker для запуска приложения, миграции для таблицы заданий, модель заданий, фабрика для генерации заданий, API Resource контроллер, методы для работы с заданиями, репозиторий для взаимодействия с ORM, Swagger для документирования API, Feature и Unit тесты.
- Клонируйте репозиторий: скачайте проект и перейдите в папку
test-task
. - Настройте окружение: создайте файл
.env
из.env.example
, настройки можно оставить по умолчанию. - Запустите контейнеры: выполните
docker-compose up -d --build
. - Установите зависимости:
docker exec -it app composer install
внутри контейнера приложения. - Сгенерируйте ключ:
docker exec -it app php artisan key:generate
. - Примените migrations:
docker exec -it app php artisan migrate
. - Запустите seeders:
docker exec -it app php artisan db:seed
. - Откройте приложение: доступно по адресу http://localhost:8888.
- Сгенерируйте документацию:
docker exec -it app php artisan l5-swagger:generate
. - Запустите тесты: выполните
docker exec -it app php artisan test
. - Через postman можно обратиться к http://localhost:8888/api/tasks с Bearer Token - token для получения доступа к таскам. Сам токен лежит в .env - API_BEARER_TOKEN
- Swagger документация после ее генерации из пункта 9 будет доступна по ссылке http://localhost:8888/admin/swagger
Теперь проект готов к использованию!
Implemented: Docker for running the application, migrations for the task table, task model, factory for generating tasks, API Resource controller, methods for working with tasks, repository for interacting with ORM, Swagger for documenting API, Feature and Unit tests.
- Clone the repository: download the project and go to the
test-task
folder. - Configure the environment: create a
.env
file from.env.example
, you can leave the default settings. - Run the containers: run
docker-compose up -d --build
. - Install dependencies:
docker exec -it app composer install
inside the application container. - Generate the key:
docker exec -it app php artisan key:generate
. - Apply migrations:
docker exec -it app php artisan migrate
. - Run seeders:
docker exec -it app php artisan db:seed
. - Open the application: available at http://localhost:8888.
- Generate documentation:
docker exec -it app php artisan l5-swagger:generate
. - Run tests: run
docker exec -it app php artisan test
. - Via postman you can access http://localhost:8888/api/tasks with a Bearer Token - token to access tasks. The token itself is in .env - API_BEARER_TOKEN
- Swagger documentation after its generation from point 9 will be available at the link http://localhost:8888/admin/swagger
Now the project is ready for use!