Ze zuper image sharing

This project is built in PHP with the Laravel framework (5.3). It is aimed for a cloud use.

The app uses redis as a Queue driver, if none is specified in the .env file. A queue is used for the upload to cloud of image files.

If you did not install redis, or cannot for whatever reason, set QUEUE_DRIVER=sync. By setting the queue to sync, it will process the queue on every request, instead of doing it in the background.

Please, please, please use either vagrant and/or an ubuntu machine, this will save you a baaaad headache.

Installation

The installation script is meant to be used on an ubuntu 14.04 (Trusty Tahr) or ubuntu 16.04 (Xenial Xerus).

If you install this on a windows, god save your soul but it may be possible. This installation script will therefor not help you, you will need to refer to the laravel docs.

It is strongly recommended if you are using vagrant to install Homestead. You also could just go with an Ubuntu virtual machine, and use the install script.

After installing you will need to execute these 3 commands to finish the setup and install the framework.

composer install
cp .env.example .env
php artisan key:generate
php artisan migrate --seed

Imagick or GD?

For thumbnail generation, we used Imagick. Imagick is not installed by default with PHP. If you don't want/haven't installed Imagick you can, or you can change the configuration file config/image.php, and change it to

 <?php
 
 return array(
 
     /*
     |--------------------------------------------------------------------------
     | Image Driver
     |--------------------------------------------------------------------------
     |
     | Intervention Image supports "GD Library" and "Imagick" to process images
     | internally. You may choose one of them according to your PHP
     | configuration. By default PHP's "GD Library" implementation is used.
     |
     | Supported: "gd", "imagick"
     |
     */
 
     'driver' => 'gd'
 
 );

Now your PHP installation will work with GD. But you might have errors with thumbnail generation! To install ImageMagick, please refer to the documentation docs (i'm bored of writing docs that nobody really reads completely....).

Install Homestead

If you do use vagrant (please make youself a favor and do so), then to install Homestead you will need git.

On linux

On a bash

vagrant box add laravel/homestead
cd ~
git clone https://github.com/laravel/homestead.git Homestead
cd Homestead
bash init.sh

After that you will need to edit your Homestead.yaml file in your homestead home directory with your favorite editor (nano ~/.homestead/Homestead.yaml). This file will define all your virtual machines.

On windows

On a cmd

vagrant box add laravel/homestead
cd %USERPROFILE%
git clone https://github.com/laravel/homestead.git Homestead
cd Homestead
init.bat

After that you will need to edit your Homestead.yaml file in your homestead home directory with your favorite editor (notepad %USERPROFILE%\.homestead\Homestead.yaml). This file will define all your virtual machines.

Configuration of your Homestead.yaml

This is an example of my own Homestead.yaml file.

---
ip: "192.168.10.10"
memory: 2048
cpus: 1
provider: virtualbox

authorize: ~/.ssh/id_rsa.pub

keys:
    - ~/.ssh/id_rsa

folders:
    - map: C:/dev/
      to: /home/vagrant/Code

sites:
    - map: homestead.app
      to: /home/vagrant/Code/image-sharing/public
      schedule: true
databases:
    - homestead

On windows, you will need to put drive letters in capital letters.

Using homestead

After installing your vagrant homestead box, you will need to execute the following command to up your machine cd ~/Homestead(cd %USERPROFILE%\Homestead) and execute the command vagrant up

Install on Ubuntu

If you posses a virtual machine with ubuntu 14.04, or higher, you can use this script.

wget -O - https://raw.githubusercontent.com/CPNV-ES/image-sharing/installation_script/install.sh | sudo bash

If you have any problems with this install script, please create an issue on the project.

Install manually

If you do not use homestead, nor a virtual machine (hang in there), then you may install all needed tools for this, such as:

PHP
composer
(phpunit only if you want testing)

Requirements

PHP >= 5.6 (php version 5.6 or higher)
OpenSSL PHP Extension
PDO PHP Extension
Mbstring PHP Extension
Tokenizer PHP Extension
XML PHP Extension

After installing php, don't forget to add it to your path, you will need it later.

Linux/Mac $ PATH:$PATH:

Windows/wamp > set PATH=%PATH%;C:\wamp\php

That is only for the PHP part, then you will need to install composer.

php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
php -r "if (hash_file('SHA384', 'composer-setup.php') === 'aa96f26c2b67226a324c27919f1eb05f21c248b987e6195cad9690d5c1ff713d53020a02ac8c217dbf90a7eacc9d141d') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
php composer-setup.php
php -r "unlink('composer-setup.php');"

After installing composer, execute the following commands to setup the project environnement cp .env.example .env && composer install && php artisan key:generate && php artisan migrate --seed . Then edit the .env file to suite your needs, please refer to the laravel documentation for that.