Snowfakery Recipe Templates repository showcases all contributed Snowfakery recipes by volunteers from numerous SFDC Community Sprints. All the recipes are under the BSD 3-Clause License and are maintained by Data Gen Toolkit team.
Most people who participate in this project have access to VS Code.
This project is not installable.
We have orgs ready for you to use during a sprint. You can request access in Slack in the snowfakery-recipe-makers channel.
We keep track of next steps in GitHub in the Issues tab
The items checked below are needed to actively contribute to the project. Find more details about these tools
Multiple steps are required to set up a development-ready environment in your local machine. After completing the initial setup, the snowfakery recipes in the repository can be utilized for loading data to a scratch org.
Salesforce Environment
CumulusCI
$ git clone https://github.com/SFDO-Community-Sprints/Snowfakery-Recipe-Templates.git
cci project init
If you want to use a scratch org to play with Snowfakery recipes in this repository, you may want to install NPSP, EDA, Outbound Funds (OBF), or Program Management Module (PMM) as well.
cci org scratch eda eda --default
to create a new scratch org and set it as a default
cci flow run eda_scratch --org eda
cci flow run sal_eda_scratch --org eda
cci org scratch dev dev --default
to create a new scratch org and set it as a default
cci flow run npsp:install_prod --org dev
cci flow run obf_scratch --org dev
cci flow run obf_npsp_scratch --org dev
cci flow run pmm_scratch --org dev
cci flow run npsp_scratch --org dev
cci org scratch npc npc --default; cci org browser
to create a new scratch org and set it as a default. No further packages are required.cci org scratch edc edc --default; cci org browser
to create a new scratch org, set it as default, and open it. No further installs are required, but education cloud may require additional setup.There are several open issues suggesting new recipes we need and fixes to existing recipes. We also welcome contributions of new recipes we haven't though of yet.
Most of our work in this repo is around creating recipes for use directly within Salesforce, so the final work should make sense within a Salesforce context. That said, Snowfakery has its own CLI that can output a file of data instead of adding it to Salesforce.
# To view the list of options for running a snowfakery recipe file
# https://snowfakery.readthedocs.io/en/docs/#command-line-interface
$ snowfakery --help
# snowfakery
# --output-format [png|svg|svgz|jpeg|jpg|ps|dot|json|txt|csv|sql]
# --output-file <fileName.extension>
# <Relative path to a recipe yml file>
$ snowfakery --output-format json --output-file src/foo.json snowfakery_samples/npsp/RD_npsp.recipe.yml