hocs-docs

This is the Home Office Correspondence Service (HOCS) document service.

Getting Started

Prerequisites

• Java 17
• Docker
• Postgres
• LocalStack

Submodules

This project contains a 'ci' submodule with a docker-compose and infrastructure scripts in it. Most modern IDEs will handle pulling this automatically for you, but if not

$ git submodule update --init --recursive

Docker Compose

This repository contains a Docker Compose file.

Start localstack (sqs, sns, s3), postgres and clamav

From the project root run:

$ docker-compose -f ./ci/docker-compose.yml up -d localstack postgres clamav

With Docker using 4 GB of memory, this takes approximately 2 minutes to startup.

Stop the services

From the project root run:

$ docker-compose -f ./ci/docker-compose.yml stop

This will retain data in the local database and other volumes.

Running in an IDE

This project contains a git-blame-ignore-revs file which can be used to ignore large formatting commits when using git blame. This also works in IntelliJ as it uses the standard git blame command to annotate commits. To see the correct blame information, you need to add the following to your git config:

git config blame.ignoreRevsFile .git-blame-ignore-revs

If you are using an IDE, such as IntelliJ, this service can be started by running the HocsDocsApplication main class. The service can then be accessed at http://localhost:8083.

You need to specify appropriate Spring profiles. Paste development,local into the "Active profiles" box of your run configuration.

Versioning

For versioning this project uses SemVer.

Authors

This project is authored by the Home Office.

License

This project is licensed under the MIT license. For details please see License