Skip to content

Tutorials

Home › Tutorials

Step-by-step guides to help you get started and master r2r and Everything-as-Code workflows. These learning-oriented tutorials take you from installation through advanced practices.

Learning Paths

Choose your path based on your experience level:

Beginner Path

Goal: Get r2r installed and understand the fundamentals

Start here if you're new to r2r and Everything-as-Code:

  1. Getting Started - Installation, first spec, first module, test suites
  2. Quick Start - Install and run first commands
  3. Your First Specification - Write Gherkin specs
  4. Your First Module - Create a Go module
  5. Understanding Test Suites - Test levels and suites

Developer Path

Goal: Master daily development workflows

Continue here to learn productive development practices:

  1. Core Workflows - TDD, building, testing, worktrees, releases
  2. TDD with Specifications - Full TDD loop
  3. Building and Testing Changes - Efficient builds
  4. Working with Git Worktrees - Parallel development
  5. Making Your First Release - Changelog and tags

Advanced Path

Goal: Implement compliance automation and CI/CD

Continue here for power user features:

  1. Advanced Practices - Compliance, CI/CD, multi-module, extensions
  2. Compliance-as-Code Basics - GxP automation
  3. CI/CD Integration - GitHub Actions setup
  4. Multi-Module Development - Dependencies
  5. Creating Custom Commands - Extend CLI

Specialized Topics

Goal: Deep dive into specific areas

Choose topics based on your needs:

  1. Specialized Topics - BDD, architecture, security, TypeScript
  2. Effective BDD Scenarios - Example Mapping
  3. Architecture Documentation - C4 diagrams
  4. Security Scanning Workflow - SAST, SBOM
  5. TypeScript Module Setup - npm modules

Tutorial Format

Each tutorial follows a consistent structure:

  • Prerequisites - What you need before starting
  • Learning objectives - What you'll accomplish
  • Step-by-step instructions - Detailed walkthrough with commands
  • Key concepts - Important takeaways
  • Troubleshooting - Common issues and solutions
  • Next steps - Where to go next

About These Tutorials

These tutorials follow the Diataxis framework and are learning-oriented. They're designed to:

  • Take you through a series of steps to complete a project
  • Help you learn by doing (hands-on practice)
  • Build your understanding progressively
  • Give you confidence through small wins

Not what you need?

Getting Help

  • Stuck on a tutorial? Check the troubleshooting section in each tutorial
  • Need more detail? See the Reference documentation
  • Want to understand why? See Explanation docs
  • Have feedback? Open an issue on GitHub

Tutorials | How-to Guides | Explanation | Reference

You are here: Tutorials — learning-oriented guides that take you through steps to complete a project.