Skip to content

A common hosted document generation service (API) for merging JSON data into xml-based templates (powered by Carbone.io)

License

Notifications You must be signed in to change notification settings

bcgov/common-document-generation-service

Common Document Generation Service

License img

Tests Maintainability Test Coverage

version pulls size

CDOGS - A common hosted service (API) for generating documents from templates, data documents, and assets

To learn more about the Common Services available visit the Common Services Showcase page.

Directory Structure

.github/                   - PR and Issue templates
app/                       - Application Root
├── docker/                - Auxillary support scripts for LibreOffice Python wrapper
├── src/                   - Node.js backend web application
└── tests/                 - Node.js backend web application tests
charts/                    - General Helm Charts
└── cdogs/                 - CDOGS Helm Chart Repository
    └── templates/         - COCDOGSS Helm Chart Template manifests
examples/                  - Collection of scripts demonstrating CDOGS usage
bcgovpubcode.yml           - BCGov public code asset tracking
CODE-OF-CONDUCT.md         - Code of Conduct
COMPLIANCE.yaml            - BCGov PIA/STRA compliance status
CONTRIBUTING.md            - Contributing Guidelines
Dockerfile                 - Dockerfile Image definition
LICENSE                    - License
SECURITY.md                - Security Policy and Reporting

Documentation

Getting Help or Reporting an Issue

To report bugs/issues/features requests, please file an issue.

How to Contribute

If you would like to contribute, please see our contributing guidelines.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

Copyright 2019 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.