TransferGo recruitment task

About The Project

Notification module made as a recruitment task

Built With

• PHP
• Symfony
• Docker
• Compose

Getting Started

Installation

Follow these simple steps

Clone API repository

dev:$ git clone [email protected]:RyuuKodex/transfer-go-task.git

1. Run docker-compose build --pull --no-cache to build fresh images
2. Run docker-compose up (the logs will be displayed in the current shell)
3. In .env or .env.local file add your Twilio and Amazon SES credentials

Endpoint

Create and send notification

  POST /api/notification

{
    "sender": "61407079-0246-47ae-8077-29039e5d798e",
    "receiver": "494572c8-d727-4753-b39f-da2fe935cd68",
    "title": "title",
    "message": "message"
}

Commands

Start the project

dev:$ docker-compose up -d

Connect to app container

dev:$ docker-compose exec -it app bash

Stop project

dev:$ docker-compose down --remove-orphans

Run tests in the container

dev:$ APP_ENV=test php bin/phpunit

Run code lint in the container

dev:$ vendor/bin/php-cs-fixer fix