https://github.com/maximedegreve/TinyFaces-Sketch-Plugin
Fill selected layers in Sketch with free stock avatars
https://github.com/maximedegreve/TinyFaces-Sketch-Plugin
plugin sketch
Last synced: 6 months ago
JSON representation
Fill selected layers in Sketch with free stock avatars
- Host: GitHub
- URL: https://github.com/maximedegreve/TinyFaces-Sketch-Plugin
- Owner: maximedegreve
- Created: 2016-12-27T14:06:25.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:02:55.000Z (about 2 years ago)
- Last Synced: 2024-08-10T14:08:07.273Z (9 months ago)
- Topics: plugin, sketch
- Language: JavaScript
- Homepage: https://tinyfac.es
- Size: 2.01 MB
- Stars: 226
- Watchers: 5
- Forks: 14
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TinyFaces 👦🏼👨🏾👩🏻 Sketch Plugin
Fill layers in Sketch with avatars & random data from [tinyfac.es](https://tinyfac.es/)...
**Features:**
- 📒 Fills text layers with random names
- 👦🏼 Fills shapes with random avatar stock photos
- 👨👩👧👦 Supports groups
- 💟 Supports symbols
- 🎚 Choose between high quality or low quality images
- 💑 Filter to only male or female
**Installation:**
- [Download](https://github.com/maximedegreve/TinyFaces-Sketch-Plugin/releases/download/v0.6.2/tinyfaces.sketchplugin.zip) the latest release of the plugin
- Un-zip
- Double-click on tinyfaces.sketchplugin
**Check out how it works:**
## Development
_This plugin was created using `skpm`. For a detailed explanation on how things work, checkout the [skpm Readme](https://github.com/skpm/skpm/blob/master/README.md)._
## Usage
Install the dependencies
```bash
npm install
```
Once the installation is done, you can run some commands inside the project folder:
```bash
npm run build
```
To watch for changes:
```bash
npm run watch
```
Additionally, if you wish to run the plugin every time it is built:
```bash
npm run start
```
## Custom Configuration
### Babel
To customize Babel, you have two options:
- You may create a [`.babelrc`](https://babeljs.io/docs/usage/babelrc) file in your project's root directory. Any settings you define here will overwrite matching config-keys within skpm preset. For example, if you pass a "presets" object, it will replace & reset all Babel presets that skpm defaults to.
- If you'd like to modify or add to the existing Babel config, you must use a `webpack.skpm.config.js` file. Visit the [Webpack](#webpack) section for more info.
### Webpack
To customize webpack create `webpack.skpm.config.js` file which exports function that will change webpack's config.
```js
/**
* Function that mutates original webpack config.
* Supports asynchronous changes when promise is returned.
*
* @param {object} config - original webpack config.
* @param {boolean} isPluginCommand - whether the config is for a plugin command or a resource
**/
module.exports = function(config, isPluginCommand) {
/** you can change config here **/
};
```
## Debugging
To view the output of your `console.log`, you have a few different options:
- Use the [`sketch-dev-tools`](https://github.com/skpm/sketch-dev-tools)
- Open `Console.app` and look for the sketch logs
- Look at the `~/Library/Logs/com.bohemiancoding.sketch3/Plugin Output.log` file
Skpm provides a convenient way to do the latter:
```bash
skpm log
```
The `-f` option causes `skpm log` to not stop when the end of logs is reached, but rather to wait for additional data to be appended to the input
## Publishing your plugin
```bash
skpm publish
```
(where `bump` can be `patch`, `minor` or `major`)
`skpm publish` will create a new release on your GitHub repository and create an appcast file in order for Sketch users to be notified of the update.