Notification Service

A service for sending SMS (and possibly emails in the future)

Building Locally

Initial Set Up

• Setup Github credentials (for fetching private dependencies)

  1. Create a Github Personal Access Token
  2. Define environment variables with your credentials (e.g., ~/.zprofile, ~./zprofile)

     export GITHUB_ACTOR=<your github username>
     export GITHUB_TOKEN=<personal access token>

• Install appropriate version of java (or use asdf)

• Set up pre-commit hook to apply formatting:

  ./gradlew addKtlintFormatGitPreCommitHook

• Copy app/src/main/resources/application.properties.sample to app/src/main/resources/application-dev.properties.

Starting the Application

1. Run docker-compose up to fire up redis.
2. Use ./gradlew bootRun to fire up the app.

Formatting

We are using ktlint to format the project.

To check that the project conforms to the style guide you can run:

./gradlew ktlintCheck

To apply formatting, run:

./gradlew ktlintFormat

IntelliJ

Press cmd + opt + L to have IntelliJ apply formatting.

You can configure Actions on Save (under Settings > Tools) to "Reformat code" automatically as you work.

Config

Our custom formatting rules are defined in .editorconfig.

Documentation

• Deployments