Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 

Foodreau logo

Foodreau

A simple Sketch plugin to fill text and image layers with recipe-related content. Useful for designing food-related layouts without resorting to Lorem Ipsum.

Installation

Sketch plugin manager

In the 'Catalog' tab of Sketch Plugin Manager, search for 'Foodreau'

Runner

In the Runner prompt, type install, then hit the Tab key, then type foodreau

Manual

  1. Download zip and extract
  2. In Sketch Plugins > Manage Plugins...
  3. Click the cog-wheel icon in lower right, and select Reveal Plugins Folder
  4. Move extracted zip to the Plugins directory

Usage

Can be used like other DataSupplier plugins. Right-click a layer to fill with recipe information, or use the toolbar Data dropdown.

Usage example GIF

To fill text layers with the appropriate information, the text layer must be named accordingly.

Layer naming example

Below is a short list of the most commonly used fields:

Layer name Description
title Title of the recipe
instructions Full text of recipe preparation instructions
extendedIngredients Collected list of recipe ingredients
creditText Name of recipe source
sourceUrl URL of recipe source

Additional fields are listed in the docs. Image layer names can be anything.

API

This plugin comes bundled with a number of offline recipes that be used without restriction. They can be found here.

If the offline recipes are not enough, this plugin can also connect to Spoonacular's recipe API. Register for a freemium API key through RapidAPI.

In the plugin menu within Sketch, navigate to the Foodreau options and click Set API key.... Your key will persist between sessions.

Advanced

Wanna store your API key on disk? Clone this repo, then create the file srv/.secret.js and store your key like so:

export const spoonacular = {
  'apikey' : 'API_KEY_GOES_HERE'
};

Run npm install to rebuild the plugin, and you should be good to go.

About

Sketch plugin for populating designs with real food recipes.

Topics

Resources

Packages

No packages published