https://github.com/danielstern/navatar
Navatar, the Node.js Avatar Generator
https://github.com/danielstern/navatar
Last synced: about 1 year ago
JSON representation
Navatar, the Node.js Avatar Generator
- Host: GitHub
- URL: https://github.com/danielstern/navatar
- Owner: danielstern
- Created: 2017-03-22T13:47:01.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-22T23:09:16.000Z (about 9 years ago)
- Last Synced: 2025-02-10T15:50:56.089Z (over 1 year ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#Navatar, the Node.js Avatar Generator
## Generate visually-pleasing, unique avatars using Node.js
###[Check out the demo!](http://navatar-demo.herokuapp.com/)
### Key Features
- Easily add randomly generated avatars to your existing Express application using the built-in middleware
- Generate fast SVG images that look good at any size
### Notes
- For production performance, it is recommended that you cache generated images as PNGs using your exisitng file server
- No support for PNG files yet (you can optionally read the SVG from the route and convert into a PNG using `svg2png` - this process works but is slow)
### How it works
Navatar uses built-in algorithms to create cellular automata, a la Stephen Wolfram's ["A New Kind of Science"](http://www.wolframscience.com/nksonline/toc.html), which heavily influenced this project.
When the MiddleWare is invoked, an SVG is randomly generated based on the key provided, and sent to the user.
### Usage
- First, install via NPM
```bash
npm install --save navatar
```
- Then, add as `express` MiddleWare...
```javascript
const { getNavatarMiddleware } = require('navatar');
const express = require(`express`);
const app = new express();
app.use('/avatar/:key.svg',getNavatarMiddleware());
app.listen(666);
```
Now, your `/avatar` route will serve up SVGs!
### Options
#### Custom width and height
Pass width and height as query paramaters to modify the size of the generated glyph. (It is recommended to use the same value for width and height.)
```javascript
//example
http://localhost/avatar/this-rocks.svg?height=150&width=150
```
### Coming Soon!
- Support for additional tree-generation algorithms
- Better color palette support
- PNG support (one day!)
### License
[CC BY](https://creativecommons.org/licenses/by/4.0/)