The Flourish SDK is our command-line tool. You’ll use the Flourish SDK to develop templates locally, then upload them to Flourish.
Install the Flourish SDK:
You can now use
flourish at the command line. Type
flourish help to see all commands and options.
Create a new template (docs)
Run/view your template (docs)
You can then upload your templates to Flourish Studio, the interactive environment where they can be used by non-coders.
Your users can enter and edit their own data (live in the browser), and change the configuration options you make available. The result is an interactive graphic that can be published, embedded, downloaded or used as the basis of a structured story.
By default, templates are freely available for anyone to use, but it’s also possible to create private templates for use within a particular organisation.
Once you’re up and running, you’ll want to start building your own templates. These resources may help:
- Example templates - fork these to create your own visualisation
- Template overview - a readable guide to templates and their files
- Reference docs - documentation for all Flourish options
And if you want help, please don’t hesitate to ask. This documentation is a work in progress - your feedback will help us improve!