Giter Club home page Giter Club logo

ethos-repl-docmosis-service's Introduction

Ethos Replacement Doc Generation Service

This application generates documents from templates using Docmosis -> Tornado.

Getting started

Prerequisites

Building

The project uses Gradle as a build tool but you don't have to install it locally since there is a ./gradlew wrapper script.

To build project please execute the following command:

    ./gradlew build

To get the project to build in IntelliJ IDEA, you have to:

  • Install the Lombok plugin: Preferences -> Plugins
  • Enable Annotation Processing: Preferences -> Build, Execution, Deployment -> Compiler -> Annotation Processors

Running

You can run the application by executing following command:

    ./gradlew bootRun

The application will start locally on http://localhost:8081

API documentation

API documentation is provided with Swagger: UI to interact with the API resources

    http://localhost:8081/swagger-ui.html

Docker container

Authenticating to ACR

Login to Azure CLI

    az login

Login to ACR

    az acr login --name hmctspublic

Docker image

Build the docker image

    docker build . -t hmcts/ethos-repl-docmosis-service:latest

Docker compose

Run the service with all its dependencies

    docker-compose -f docker/app.yml up -d

To stop the service

    docker-compose -f docker/app.yml down

Developing

Unit tests

To run all unit tests please execute following command:

    ./gradlew test

Coding style tests

To run all checks (including unit tests) please execute following command:

    ./gradlew check

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

ethos-repl-docmosis-service's People

Contributors

jacarrete avatar gauravchawlamoj avatar jthmcts avatar hsjhita avatar kiran-pannala avatar btensay avatar angela-lw avatar phaniperla avatar rababrabab avatar bmj-vsalivendra avatar phani-perla1 avatar shravanmechineni avatar adusumillipraveen avatar isherraikmo avatar cindychmcts avatar msancaktutar avatar dependabot-preview[bot] avatar endakelly avatar rajaram-nagarajan avatar hmcts-jenkins-ethos[bot] avatar

Watchers

 avatar

Forkers

chromico

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.