Skip to main content
The goal of this first step is to familiarize yourself with implementing actions and effects from scratch. The specifications of the workflow are available bellow.

Orders management - Specifications

If you are not familiar with the specifications, you can refer to the specification documentation.

Starting the development

Requirements

To generate a workflow, you’ll need to have the following tools installed: Install yarn if you don’t have it already:
npm install --global yarn

Setup the project

Clone the repository and open it in Vim your favorite IDE.

Orders management - Repository

Create a new branch for your changes:
git checkout -b feature/<your-name>-step-1
Now, you’ll need to install the dependencies:
yarn install

Generating the workflow

While developing, you’ll be generating in the staging environment. To generate the workflow, you’ll need to export the SU_PASSWORD environment variable in your terminal (or directly in your .<bash | zsh>rc file).
export SU_PASSWORD=<provided-password>
You can ask the password of the staging environment to your colleagues. Update the YOUR_NAME variable in the .env.local-to-staging file with your name. Also, remove the “REPLACE_ME_AFTER_FIRST_GENERATION” from the WORKFLOWS variable and put an empty string. To generate the workflow, run the following command:
yarn generate:local-to-staging
When generating for the first time a workflow, you will create a new ID. This ID will be displayed in the console. Copy this ID and use it to update the WORKFLOWS variable in the .env.local-to-staging file. You’ll need to run the generation command again for it to be fully functional.
That’s it! You’ve generated your first workflow 🚀 Check it in the staging environment at https://trace.staging.stratumn.com/workflowoverview/your_workflow_id