document-generation-showcase
Document Generation Showcase 
Documentation, Code Templates and a Showcase application to demonstrate features of the Natural Resources Common Document Generation Service
To learn more about the Common Services that are available visit the Common Services Showcase page.
Directory Structure
.github/ - PR and Issue templates
app/ - Node.js backend web application
└── frontend - Vue.js frontend web application
openshift/ - OpenShift-deployment specific files
CODE-OF-CONDUCT.md - Code of Conduct
CONTRIBUTING.md - Contributing Guidelines
Jenkinsfile - Top-level Pipeline
Jenkinsfile.cicd - Pull-Request Pipeline
LICENSE - License
vetur.config.js - Vetur configuration
Documentation
Quick Start Dev Guide
You can quickly run this application in production mode after cloning with the following commands (assuming you have already set up local configuration as well). Refer to the Application Readme for more details.
cd app
npm run all:install
npm run all:build
npm run serve
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-2022 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.