README.md

AB2D

Table of Contents

1. Create volume directory
2. Running Locally with Intelij
3. Installing and Using Pre-Commit

Create volume directory

1. Create a volume directory

   $ mkdir -p /opt/ab2d

2. Note that this directory acts as a shared volume for the API and worker containers

Running Locally with Intelij

1. Remove comments in the docker-compose.yml to set db ports

      ports:
      - "5432:5432"

2. Run postgress and localstack locally using Docker

   $ docker-compose up db localstack

Worker Setup

3. Select Run/Debug Configuration > Edit Configurations > add configuration (+) > Spring Boot
4. In Main Class select gov.cms.ab2d.worker.SpringBootApp
5. Go to 1Password and search for 'AB2D Local Env Variables'. Use the configs in the note for the Environment Variables field
6. Run the configuration

API Setup 6. Select Run/Debug Configuration > Edit Configurations > add configuration (+) > Spring Boot 7. In Main Class select gov.cms.ab2d.api.SpringBootApp 8. Go to 1Password and search for 'AB2D Local Env Variables'. Use the configs in the note for the Environment Variables field 9. Run the configuration

AB2D Deploy

Installing and Using Pre-commit

Anyone committing to this repo must use the pre-commit hook to lower the likelihood that secrets will be exposed.

Step 1: Install pre-commit

You can install pre-commit using the MacOS package manager Homebrew:

brew install pre-commit

Other installation options can be found in the pre-commit documentation.

Step 2: Install the hooks

Run the following command to install the gitleaks hook:

pre-commit install

This will download and install the pre-commit hooks specified in .pre-commit-config.yaml.