Starter Project

Introduction

The Starter Project is meant to serve as a step-by-step guide for new employees in our service creation and development processes. The goal of the starter-project is to ensure your development environment is fully set up and to start the process of familiarization with our development workflow. The tutorial service you will create will cover a broad swath of concepts, such as:

  • How our frameworks, libraries and tools work

  • Creation and updating of endpoints

  • Service and dependency deployment in a local cluster

  • Dependency management and versioning

  • Integration testing

  • Database integration

  • Health checks and service readiness

  • Exception Handling

  • Data mocking

This tutorial is intended to give you a broad overview of our service architecture and development processes, and as such it is quite involved. If you have questions along the way, review the developer guides available on the NGSS Documentation Site, as well as our Slack and StackOverflow sites for helpful information. If you cannot find the information you need or still need help, you can also post a message in the greenfield-dev Slack channel, and someone will assist you with your issue.

Follow the instructions on the following pages closely, and feel free to reach out to the Onboarding team for guidance.

Prerequisites

It is assumed before beginning that you have completed:

Also ensure that Docker Desktop is running and that Kubernetes has been enabled.

Getting Started

Clone the Starter Project

The starter project can be cloned from: https://coderepo.mobilehealth.va.gov/scm/ckm/starter-project.git

git clone https://coderepo.mobilehealth.va.gov/scm/ckm/starter-project.git

Create A New Branch

Before you begin, create a new branch off of the main branch of the starter-project (recommend the name be "starter_" plus your initials).

git checkout -b <branchName>

After the above command has been executed, make sure you are in the newly created branch by executing git branch.