https://github.com/rmhdev/identicon
Configurable Identicon generator built with Silex and Imagine.
https://github.com/rmhdev/identicon
avatar identicon identicon-generator imagine php silex
Last synced: 4 months ago
JSON representation
Configurable Identicon generator built with Silex and Imagine.
- Host: GitHub
- URL: https://github.com/rmhdev/identicon
- Owner: rmhdev
- License: mit
- Created: 2013-09-14T17:02:58.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2016-01-09T19:48:56.000Z (over 10 years ago)
- Last Synced: 2026-01-11T15:27:34.311Z (6 months ago)
- Topics: avatar, identicon, identicon-generator, imagine, php, silex
- Language: PHP
- Homepage: identicon.rmhdev.net
- Size: 182 KB
- Stars: 9
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Identicon
PHP aplication that generates identicons.
It is built with [Silex][] and [Imagine][],
and is inspired by Github's [Identicons][] project.
[](https://travis-ci.org/rmhdev/identicon)
**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:
You can check the [online demo][].
## Installation
Get the source code of the project from GitHub. You have two options:
A. Clone it:
```bash
git clone git@github.com: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:
```bash
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:
```bash
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:
```javascript
{
"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
### 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
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:
```bash
php ./vendor/bin/phpunit
```
If you don't have `phpunit` installed, run:
```bash
php ./composer.phar install
```
## Copyright and license
Code and documentation copyright 2016 Rober Martín.
Code released under [MIT license](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.
[Imagine]: http://imagine.readthedocs.org
[wikipedia]: http://en.wikipedia.org/wiki/Identicon
[online demo]: http://identicon.rmhdev.net
[latest release]: https://github.com/rmhdev/identicon/releases
[Composer]: http://getcomposer.org/
[Silex]: http://silex.sensiolabs.org
[how to configure your server]: http://silex.sensiolabs.org/doc/web_servers.html
[Travis page]: https://travis-ci.org/rmhdev/identicon
[Creative Commons CC BY 4.0]: http://creativecommons.org/licenses/by/4.0/
[Identicons]: https://github.com/blog/1586-identicons
[Rober Martín]: http://rmhdev.net/
[@rmhdev]: http://twitter.com/rmhdev