Skip to content

alexdeane/Documentor

Repository files navigation

Overview

This repository contains a (currently) barebones example implementation of a CCDA XML document repository in .NET

Terms to know:

  • Registry - Name given to the database which holds queryable data for the documents
  • Repository - Name given to the store which contains the raw content of the documents
  • RespondingGateway - SOAP interface which serves documents to external parties

There are 3 operations available:

  • Create/register documents
    • Creates and registers one or more documents
    • Returns Success status or an error if one occurred
  • Query documents
    • Allows client to query the registry using a variety of parameters
    • Returns a list of matched registry objects with metadata and identifying information for the documents
  • Retrieve documents (repository)
    • Returns The contents of one or more documents

Technologies

registry: MongoDB
repository: Minio
api: ASP.Net Core (w/ CoreWCF)

Dev Quickstart

  1. Configure your IDE to run in Development

  2. Run docker-compose up in the root directory

    By default compose will not launch the API so you can debug your own version in your IDE. To run the API in the container, run docker-compose --profile with_api up

  3. Try some example queries

  4. The minio dashboard (repository storage solution) is located at http://localhost:9001/ by default

About

An example implementation of a CCDA XML document repository in .NET

Resources

License

Stars

Watchers

Forks

Contributors

Languages