Skip to content

Latest commit

 

History

History
166 lines (118 loc) · 4.07 KB

README.md

File metadata and controls

166 lines (118 loc) · 4.07 KB
Raw

Identicon

PHP aplication that generates identicons. It is built with Silex and Imagine, and is inspired by Github's Identicons project.

Build Status

What is an identicon? (from wikipedia)

It is a visual representation of a hash value [...] that serves to identify a user of a computer system as a form of avatar while protecting the users' privacy.

How to use

If you want to get username's avatar, you only have to use the next URL:

http://your-identicon-server/username.png

The response of the app will be the next image:

Identicon demo

You can check the online demo.

Installation

Get the source code of the project from GitHub. You have two options:

A. Clone it:

git clone [email protected]:rmhdev/identicon.git /MY/FOLDER
cd /MY/FOLDER
git checkout v2.0.0

B. Download it:

Check the latest release and copy it to your installation folder.

Project dependencies

Retrieve all the dependencies using Composer. Install it and then run the next command:

php ./composer.phar install --no-dev

Server configuration

This project is built using Silex. The official docs will give you more information about how to configure your server. Some tips:

  • the document root must point to the identicon/web/ directory.
  • folders in identicon/var/ must be writable by the web server.

Play with Identicon

If you are using PHP 5.4+, its built-in web server will help you to play with this project:

cd identicon/
php -S localhost:8080 -t web web/index.php

Easy, right? Just open a browser and enter http://localhost:8080

Customize the identicon generator

In the config folder, copy the file parameters.dist.json and paste it with the name parameters.json. The default values are:

{
    "identicon.config": {
        "blocks": 5,
        "block-size": 70,
        "margin": 35,
        "background-color": "f0f0f0"
    },
    "identicon.type": {
        "default": "plain",
        "extra": ["circle", "pyramid", "rhombus"]
    }
}

Default Identicon types

Plain, pyramid, circle and rhombus

Plain type Pyramid type Circle type Rhombus type

Create your own Identicons

Take a look at src/Identicon/Type/. If you want to create a new Identicon type, extend the AbstractIdenticon class. For example:

<?php

namespace Identicon\Type\MyType;

use Identicon\AbstractIdenticon;
use Imagine\Image\Point;

class Identicon extends AbstractIdenticon implements IdenticonInterface
{
    protected function drawBlock($x, $y)
    {
        //parent::drawBlock($x, $y);
        $this->getImage()->draw()->dot(
            $this->getCell($x, $y)->getCenter(),
            $this->getColor()
        );
    }
}

Unit tests

Check the Travis page to see the build status. If you want to run the tests by yourself, run the next command:

php ./vendor/bin/phpunit

If you don't have phpunit installed, run:

php ./composer.phar install

Copyright and license

Code and documentation copyright 2016 Rober Martín. Code released under MIT license. Docs released under Creative Commons CC BY 4.0.

This project is inspired by Github's Identicons project.

Author

My name is Rober Martín (@rmhdev). I'm a developer from Donostia / San Sebastián.