Backend

Last Updated: October 21, 2026

On this page, you'll find links to how Backend Engineering works on VA.gov.

Communication channels

• Slack channels: #vfs-platform-support

Table of contents

The following list is a set of resources compiled by the people in your practice area to help you do your work and answer questions you might have.

• Getting started

  • Logistics

  • Background/FAQ

  • Issue Templates and Access Request Templates

• Environment setup

  • Native setup instructions

  • Docker setup

    • Docker Desktop (Engine + Compose)

      • Mac

      • Windows

    • Linux (Ubuntu)

      • Docker Engine

      • Docker Compose

  • Optional application configuration

  • Setting up your local frontend environment

• Common tasks

  • Clone & Build

    • Base Setup

  • Run the app

    • Running the app

    • 
      

    • 
      

  • Logging in

    • Test User Dashboard

    • User Test Accounts

  • Testing & Tools

    • Running test suite

      • Spec file examples

      • rspec-rails

    • Load testing process

    • Accessing Staging

    • Datadog

      • Dashboards

      • APM Home

  • API Reference

    • vets-api Swagger/OpenAPI Docs

  • Database Migrations

  • Mocking data

    • Mocking an external service

    • Mocking error responses

    • Caching multiple responses

• Code organization

  • We enforce a consistent code style with Rubocop code linting

  • - used to manage unreleased features

  • vets-api config/settings

  • Standards and conventions

    • Backend best practices

    • for reference: 18F API standards (some good advice here)

    • Backend Endpoint Tutorial

    • Vets-API Endpoint Punch List Presentation

    • Service classes

    • Encrypted Database Attributes

• Development workflow

  • Workflow

  • Getting help in Slack

  • Continuous Integration Process

  • Engineering Key Management

  • How to File Bugs, Tasks, and Questions

    • Bugs

    • Triage Tier Definitions

• Code review

  • Code Review Norms

  • Deploy and Release Process

• Triage Processes

  • Incident Management

  • Triaging API Errors

  • Support Tiers

• External Service Partners (aka APIs)

  • List of Upstream Services

  • External Service Integrations

  • Breakers gem - Handles downtime for external services by marking them as “down” while continuously checking for valid response statuses

  • Facilities Locator - A single consolidated place where veterans and beneficiaries can easily find and understand high-level information about facilities offering priority VA benefits and services

  • HCA - Health Care Applications

  • BB - Blue Button

  • GIBFT - GI Bill Feedback Tool

• Datasources

  • VA Databases and Data Systems

  • Technical Architecture

  • VSP Topology

Help and feedback

• Suggest content changes to this page.

• Submit new Platform Website content.

• Get help from the Platform Support Team in Slack.

• Submit a feature idea to the Platform.