Backend

Introduction

In this section, you'll find information specific to how Backend Engineering works on VA.gov.

Communication channels

• Slack channels: #vfs-platform-support

• Github labels: platform-cop-backend, backend

Points of contact

The Backend points of contact are:

• Eric Boehs

  • @Eric Boehs on Slack, @ericboehs  on Github

• Lindsey Hattamer on Slack, @LindseySaari on Github

  • @a user

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. Some of the links may take you to other sites and resources outside this repo. If you need a hand with anything, don't hesitate to ping the Slack channels and/or people listed above.

• 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

    • Running the app Natively

    • Running the app with Docker

  • Logging in

    • Test User Dashboard

    • User Test Accounts

  • Testing & Tools

    • Running test suite

      • Spec file examples

      • rspec-rails

    • Load testing process

    • Accessing Staging

    • Accessing Internal Resources

       (Jenkins, Sentry)

    • Datadog

      • Dashboards

      • APM Home

  • API Reference

    • vets-api Swagger/OpenAPI Docs

  • Database Migrations

    • Database Migration Practices

  • Mocking data

    • Mocking an external service

    • Mocking error responses

    • Caching multiple responses

• Code organization

  • We enforce a consistent code style with Rubocop code linting

  • Feature Toggles - used to manage unreleased features

  • vets-api config/settings

  • Standards and conventions

    • Team engineering practices directory

    • 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

  • How to Contribute

  • Communication norms

  • 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

    • BRD Deployment process

    • Deploy Details (K8s vs BRD)

• 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 (Latest)

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.