Giter Club home page Giter Club logo

draft-store's Introduction

Build Status Codacy Badge Codacy Badge

Draft store

The Draft store micro-service provides a ’save and resume’ feature for reform applications via an internal API. It stores a draft json document against the userId provided.

Low Level Design

Getting Started

Prerequisites

Building

To build the project execute the following command:

./gradlew build

Running

Before you run the application you have to define database connection.
You can do this be either setting environment variables or creating application-default.yaml file.
Run the application by executing:

./gradlew bootRun

Operational note

When operating this service with live data, no one should under any circumstances view the encrypted data. The reason for this is because it would be considered under Article 14 of GDPR that we had commenced processing data. Then we would have thirty days to notify any third party parties mentioned in the application that we had commenced processing their data. This must not happen as the citizen, who is creating the application, has not yet submitted their application.

API documentation

API documentation is provided with Swagger.
You can view the json spec here: http://localhost:8800/v2/api-docs
Swagger UI is available here: http://localhost:8800/swagger-ui.html
Updates to master documentation are reflected here: https://hmcts.github.io/reform-api-docs/swagger.html

Developing

Unit tests

To run all unit tests execute the following command:

./gradlew test

Functional tests

To run all functional tests execute the following command:

./gradlew functionalTest

Code quality checks

We use checkstyle and PMD.
To run all checks execute the following command:

./lint.sh

License

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

draft-store's People

Contributors

constantinpr avatar damiandunajski avatar doncem avatar jasonpaige avatar karoljastrzebski avatar lgonczar avatar rkondratowicz avatar rlewan avatar timja avatar

Watchers

 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.