Git Product home page Git Product logo

document-management-store-app's Introduction

Document Management Store App

License: MIT Build Status codecov Codacy Badge Codacy Badge Known Vulnerabilities

Document Management is a backend service to store and retrieve documents.

Tech

It uses:

  • Java8
  • Spring boot
  • Junit, Mockito and SpringBootTest and Powermockito
  • Gradle
  • lombok project - Lombok project

Plugins

Environment variables

The following environment variables are required:

Name Default Description
IDAM_USER_BASE_URI - Base URL for IdAM's User API service (idam-app). http://localhost:4501 for the dockerised local instance or tunneled dev instance.
IDAM_S2S_BASE_URI - Base URL for IdAM's S2S API service (service-auth-provider). http://localhost:4502 for the dockerised local instance or tunneled dev instance.
MAX_FILE_SIZE 100MB Max file size

Note: The MAX_FILE_SIZE enforces limit on the document upload in the document management backend service. Additionally, the max request content length (including file sizes) need to be configured for the IIS web server (on Azure) via maxAllowedContentLength property for request filter in web.config (config file within source repository).

Quickstart

# Get the connection string for Azure Blob Store and put it in place of getOneFromPortalAzure in application.yaml
# Do not commit it!!!
azure:
  storage:
      connection-string: ${STORAGEACCOUNT_PRIMARY_CONNECTION_STRING:getOneFromPortalAzure}
# Cloning repo and running though docker
git clone https://github.com/hmcts/document-management-store-app.git
cd document-management-store-app/
./buildrundm-docker.sh
# Run this script to aquire IDAM credentials required for DM API.
./idam.sh

Integration

There is currently a Java Client available here: https://github.com/hmcts/document-management-client

Swagger UI

To view our REST API go to {HOST}:{PORT}/swagger-ui.html

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

API Endpoints

A list of our endpoints can be found here

https://hmcts.github.io/reform-api-docs/swagger.html?url=https://hmcts.github.io/reform-api-docs/specs/document-management-store-app.json

document-management-store-app's People

Contributors

pawelkaczmarekuk avatar alectronic0 avatar dwaynebailey avatar louisblack avatar rafalkalita avatar ngul avatar agilks avatar adusumillipraveen avatar daniel-lam avatar hemantt avatar timja avatar mhisltd avatar adr1ancho avatar nitinprabhu avatar linusnorton avatar cakeben avatar danielepolencic avatar gbenadikar avatar mario-paniccia avatar alexsoliri avatar aliveni avatar dependabot-support avatar shaibazkhan avatar

Watchers

James Cloos avatar  avatar

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.