Skip to content

Latest commit

 

History

History
76 lines (41 loc) · 3.66 KB

getting-started.md

File metadata and controls

76 lines (41 loc) · 3.66 KB
Raw

This file is deprecated. The most recent information should be at https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/platform/engineering

Getting Started

To build a service on the Veteran-facing Services Platform, which can be anything from a digital form to a map-based facility locator, developers will create a Frontend experience in React on Vets-Website, and connect it to an Integration on Vets-API, which manages the data flow to and from VA systems.

Get started

  1. Confirm that your team's Project Manager has added your name, email address, and Github username to the team spreadsheet and sent it to DSVA. You'll know when you can visit this Github repo and see the content.

  2. Follow the steps to create new SSH keys, configure, and test the SOCKS proxy.

  3. Verify that you have

  4. Review all the content this folder — DeveloperDocs

  5. Review the frontend documentation for Vets-Website.

  6. Review the backend documentation for Vets-API.

Development

Code repositories

The Veteran-facing Services Platform is broken into three parts:

  1. Vets-Website, which contains frontend applications and components users interact with

  2. Vets-API, a JSON-based API used by the frontend to provide data to and from VA systems

  3. Vets-JSON-Schema, which contains shared resources used to structure and validate form data between Vets-Website and Vets-API.

Local development environment setup

  1. How to setup your front end VA.gov local environment
  2. How to setup your back end VA.gov local environment
  3. After you are setup and running both front-end and back-end servers, try logging in using a mock user. Information on how to login with a mock user can be found here.
  4. Mock test users
  5. Once you can seccessfully login you should be setup for developing on VA.gov.

Internal Tools

To get access to metrics, build logs, deployment information and exception details, see Internal Tools Access documentation.

Get help

DSVA engineering resources are available to provide guidance and support through the development effort.

If you encounter issues or have any questions, raise them in the #vfs-platform-support Slack channel, or reach out to your DSVA contact.

Next: Environments

Back: Developer Docs Introduction