API AVATAR

What is it?

This API has the function of serving and managing Avatars. The service allow to serve the avatars in different sizes and types of image Upload avatars associated with emails and delete avatars.

How do I use it?

FIRST - Clone this repo

git clone https://github.com/matiass/docker-lumen-avatar-api.git
cd docker-lumen-avatar-api

SECOND - Configuration

To change configuration values, look in the docker-compose.yml file and change the php container's environment variables. You have to modify the following variables with your gmail account data to make it work.

MAIL_USERNAME: [email protected]
MAIL_PASSWORD: mipassword

E-mails will only be sent when the variable APP_ENV has the following value:

APP_ENV: production    

THIRD - Docker Setup [IF YOU DO NOT HAVE DOCKER]

Docker for Mac

Docker for Windows

Docker for Linux

FOURTH - Build & Run

sudo docker-compose up -d
sudo docker exec -ti lumen_avatar_php composer install
sudo docker exec -ti lumen_avatar_php php artisan cache:clear
sudo docker exec -ti lumen_avatar_php composer dump-autoload
sudo docker exec -ti lumen_avatar_php php artisan migrate

FIFTH - Enjoy

Avatar API is running! (http://localhost:80/...)

Do you believe me, don't you?

Go to TEST SECTION

How do i Test it?

sudo docker exec -ti lumen_avatar_php phpunit --stderr

Methods AVAILABLE

Check the Avatar_API.raml file

Stop Everything

sudo docker-compose down

Inconming Features

• Cache
• A control-script for managing the docker-infrastructure components for API Avatar
• Email queue