https://github.com/SyntonicApps/slackicons

A simple Node.js module for generating Slack-like profile icons
https://github.com/SyntonicApps/slackicons

nodejs slack

Last synced: 11 months ago
JSON representation

A simple Node.js module for generating Slack-like profile icons

• Host: GitHub
• URL: https://github.com/SyntonicApps/slackicons
• Owner: SyntonicApps
• License: mit
• Created: 2017-08-25T23:18:56.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T00:21:37.000Z (over 3 years ago)
• Last Synced: 2025-06-21T15:25:54.077Z (about 1 year ago)
• Topics: nodejs, slack
• Language: JavaScript
• Size: 188 KB
• Stars: 11
• Watchers: 2
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# slackicons

A simple Node.js module for generating Slack-like profile icons

![example 1](https://raw.githubusercontent.com/SyntonicApps/slackicons/master/example1.png)

![example 2](https://raw.githubusercontent.com/SyntonicApps/slackicons/master/example2.png)

![example 2](https://raw.githubusercontent.com/SyntonicApps/slackicons/master/example3.png)

Install `npm install slackicons`

Import `const slackicons = require('slackicons')`

## Usage

The `generate` method generates an image, taking an optional random seed and image size.

```

const fs = require('fs');

const slackicons = require('slackicons');

const options = {

    seed: 'slackicons', // Optional, specifies start seed for RNG

    size: 1000 // Optional, specifies output image width and height in pixels (default: 1000)

};

slackicons.generate(options).then((buffer) => {

    // Buffer MIME type is image/png

    fs.writeFileSync('./output.png', buffer);

}).catch((err) => {

    console.error(`Error: ${err}`);

});

```

NOTE: A size of 500 or greater is recommended until some sort of anti aliasing is added.

## Building

slackicons uses Babel to build. Install the latest version of [Node.js](https://nodejs.org/en/)

`npm install`

`npm run build`

The build script transpiles all files in `/src` and outputs them in `/dist`

## Tests

Mocha tests are located in `/test`

[Chai](https://github.com/chaijs/chai) is used for assertion, and [nyc](https://github.com/istanbuljs/nyc) is used for code coverage.

`npm install`

`npm test`

## Contributing

Feel free to fork and PR! I only ask that you follow the ESLint rules set in `.eslintrc.js`.

PRs with ESLint errors will not be accepted.

Make sure to add any Mocha tests for new features!

## [Changelog](CHANGELOG.md)

## [License](LICENSE)