Getting Started

Walk through your first time using the application.

Step 1: Create an Account

Before signing up, you should receive an email inviting you to create an account. Accept the invitation and you will be brought to a sign-up page. Enter your account details and create a password.

Step 2: Log in

After signing up, you will be brought to the login page. Log in using the email address and password specified in the previous step.

You will see at least one project upon first login. These are organization projects to which you have access. Contact your organization’s admin if you do not know which project is for your personal use.

Once you know which project to use, let’s begin by clicking on that project. You should then see the pipelines page.

Step 3: Create a Simple Pipeline

Click on “New Pipeline” in the top-left. Enter a friendly name for your pipeline, such as “Getting Started”.

After submitting the dialog, you should see your new pipeline appear in the list. Click on the “Open in Builder” button on the pipeline card.

Step 4: Add a Step to the Pipeline

In the left-hand sidebar, find the step module named “Debug”. Drag and drop an instance of this step into the design area.

Select the new step. Observe the right-hand sidebar, where we can make customizations to step fields.

For this example, we don’t need to change any fields. Simply click “Save” in the top-left of the builder, enter any short comment, and click “Save”.

Step 5: Run the Pipeline

Click the “Run” button at the top of the page. In the dialog, click “Run” again.

You will be brought to the run output page, where we can monitor the progress of the pipeline run. Notice that the debug message (which was “Hello world!” if you left the step unchanged) is printed to the output.

Congratulations! You just built and ran your first Refactr pipeline.

For next steps, visit the Tutorials page, or continue reading the documentation.