-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deploying to gh-pages from @ c77755b 🚀
- Loading branch information
1 parent
b02eb04
commit ca1e3a0
Showing
454 changed files
with
727 additions
and
15,759 deletions.
There are no files selected for viewing
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,67 +1,147 @@ | ||
<!-- PROJECT SHIELDS --> | ||
<!-- [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=bcgov_nr-quickstart-typescript&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=bcgov_nr-quickstart-typescript) --> | ||
<p><a | ||
href="https://github.com/bcgov/nr-forest-client/actions/workflows/merge.yml"><img | ||
src="https://github.com/bcgov/nr-forest-client/actions/workflows/merge.yml/badge.svg" | ||
alt="Merge to Main" /></a> <a | ||
href="https://github.com/bcgov/nr-forest-client/actions/workflows/analysis.yml"><img | ||
src="https://github.com/bcgov/nr-forest-client/actions/workflows/analysis.yml/badge.svg" | ||
alt="Unit Tests and Analysis" /></a></p> | ||
<p><a href="/../../issues"><img | ||
src="https://img.shields.io/github/issues/bcgov/nr-forest-client" | ||
alt="Issues" /></a> <a href="/../../pulls"><img | ||
src="https://img.shields.io/github/issues-pr/bcgov/nr-forest-client" | ||
alt="Pull Requests" /></a> <a href="/LICENSE.md"><img | ||
src="https://img.shields.io/github/license/bcgov/nr-forest-client.svg" | ||
alt="MIT License" /></a> <a | ||
href="https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md"><img | ||
src="https://img.shields.io/badge/Lifecycle-Experimental-339999" | ||
alt="Lifecycle" /></a></p> | ||
<p>The nr-forest-client is a node.js application built with <a | ||
href="https://vuejs.org">Vue.js</a> in typescript as frontend, <a | ||
href="https://spring.io/projects/spring-boot#learn">Spring boot java</a> | ||
as backend, postgres and oracle for database, integrated with the <a | ||
href="https://github.com/bcgov/greenfield-template">greenfield-template</a> | ||
to automate the process for testing, security scanning, code quality | ||
checking, image building and deploying.</p> | ||
<h2 id="frontend">Frontend</h2> | ||
<p>The frontend is built in Vue3 composition api, more info <a | ||
href="frontend/index.html">here</a></p> | ||
<h2 id="backend">Backend</h2> | ||
<p>The backend is built in Java 17 using Spring Boot 3. It is composed | ||
of multiple components, more info about the <a | ||
href="backend/index.html">backend here</a>, the <a | ||
href="legacy/index.html">legacy</a> part that handles oracle connections | ||
and the <a href="processor/index.html">processor</a> that handles the | ||
submission processing part.</p> | ||
<h2 id="email-templates">Email templates</h2> | ||
<p>For more info about the email templates, <a | ||
href="backend/docs/MAIL_FORMAT.md">click here</a></p> | ||
<h2 id="automated-end-to-end-tests">Automated End-to-End tests</h2> | ||
<p>For automated end-to-end tests with cypress you can check <a | ||
href="cypress/index.html">here</a>. This is used to validate user | ||
journeys and some other cases.</p> | ||
<h2 id="database-schema-documentation">Database Schema | ||
documentation</h2> | ||
<p>As the application evolves, so does the data, and to control the | ||
evolution of the database that stores all this new data. To make it in a | ||
controllable way, we can apply the same strategy we use for our codebase | ||
into our database. To achieve that, we can use tools that will version | ||
and apply changes into the database in a controlled way. Team Alliance | ||
decided to make use of <a | ||
href="https://documentation.red-gate.com/flyway">Flyway</a> as the | ||
de-facto tool to database versioning. This means that we can recreate | ||
the database structure as many times as we need, along with basic data | ||
that needs to be inserted into the database.</p> | ||
<p>We have the database schema documented using <a | ||
href="https://schemaspy.org/">SchemaSpy</a>. This is particularly useful | ||
tool for database administrators, developers, and analysts who need to | ||
understand the structure and relationships within a database. This allow | ||
us to automatically generate a visualization of the database schema | ||
through Entity-Relationship (ER) diagrams. These diagrams help users | ||
quickly grasp the relationships between tables, making it easier to | ||
navigate and understand complex databases.</p> | ||
<p>You can find our database diagram on <a | ||
href="https://bcgov.github.io/nr-forest-client/schema/nrfc/relationships.html">this | ||
page</a> and more information about the database on <a | ||
href="https://bcgov.github.io/nr-forest-client/schema">this page</a></p> | ||
<!DOCTYPE html> | ||
<html> | ||
<head> | ||
<meta charset="utf-8"> | ||
<meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
<title>default</title> | ||
<!-- Tell the browser to be responsive to screen width --> | ||
<meta content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no" name="viewport"> | ||
<link rel="icon" type="image/png" sizes="16x16" href="favicon.png"> | ||
<!-- Bootstrap 3.3.5 --> | ||
<link rel="stylesheet" href="bower/admin-lte/bootstrap/css/bootstrap.min.css"> | ||
<!-- Font Awesome --> | ||
<link rel="stylesheet" href="bower/font-awesome/css/font-awesome.min.css"> | ||
<!-- Ionicons --> | ||
<link rel="stylesheet" href="bower/ionicons/css/ionicons.min.css"> | ||
<!-- DataTables --> | ||
<link rel="stylesheet" href="bower/datatables.net-bs/css/dataTables.bootstrap.min.css"> | ||
<link rel="stylesheet" href="bower/datatables.net-buttons-bs/css/buttons.bootstrap.min.css"> | ||
<!-- Code Mirror --> | ||
<link rel="stylesheet" href="bower/codemirror/codemirror.css"> | ||
<!-- Fonts --> | ||
<link href='fonts/indieflower/indie-flower.css' rel='stylesheet' type='text/css'> | ||
<link href='fonts/source-sans-pro/source-sans-pro.css' rel='stylesheet' type='text/css'> | ||
|
||
<!-- Theme style --> | ||
<link rel="stylesheet" href="bower/admin-lte/dist/css/AdminLTE.min.css"> | ||
<!-- Salvattore --> | ||
<link rel="stylesheet" href="bower/salvattore/salvattore.css"> | ||
<!-- AdminLTE Skins. Choose a skin from the css/skins | ||
folder instead of downloading all of them to reduce the load. --> | ||
<link rel="stylesheet" href="bower/admin-lte/dist/css/skins/_all-skins.min.css"> | ||
<!-- SchemaSpy --> | ||
<link rel="stylesheet" href="schemaSpy.css"> | ||
|
||
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries --> | ||
<!-- WARNING: Respond.js doesn't work if you view the page via file:// --> | ||
<!--[if lt IE 9]> | ||
<script src="bower/html5shiv/html5shiv.min.js"></script> | ||
<script src="bower/respond/respond.min.js"></script> | ||
<![endif]--> | ||
</head> | ||
<!-- ADD THE CLASS layout-top-nav TO REMOVE THE SIDEBAR. --> | ||
<body class="hold-transition skin-blue layout-top-nav"> | ||
<div class="wrapper"> | ||
<!-- Main content --> | ||
<!-- Full Width Column --> | ||
<div class="content-wrapper"> | ||
<!-- Content Header (Page header) --> | ||
<section class="content-header"> | ||
<div class="callout callout-info"> | ||
<h4>SchemaSpy Analysis of default</h4> | ||
<p>Generated on Sat Nov 16 11:04 GMT 2024</p> | ||
</div> | ||
</section> | ||
<!-- Main content --> | ||
<section class="content"> | ||
<div class="box box-primary"> | ||
<div class="box-header with-border"> | ||
<h3 class="box-title">Database Properties</h3> | ||
<span class="label label-primary pull-right"><i class="fa fa-cog fa-2x"></i></span> | ||
</div><!-- /.box-header --> | ||
<div class="box-body"> | ||
<p>Database Type: PostgreSQL - 16.4 (Debian 16.4-1.pgdg110+2)</p> | ||
</div><!-- /.box-body --> | ||
</div> | ||
<div class="box box-primary"> | ||
<div class="box-header with-border"> | ||
<h3 class="box-title">1 Schemas</h3> | ||
<span class="label label-primary pull-right"><i class="fa fa-database fa-2x"></i></span> | ||
</div><!-- /.box-header --> | ||
<div class="box-body"> | ||
<table | ||
id="database_objects" | ||
class="table table-bordered table-striped dataTable" | ||
role="grid" | ||
data-paging="true" | ||
data-page-length="50" | ||
data-length-change="false"> | ||
<thead> | ||
<tr> | ||
<th valign="bottom">Schema</th> | ||
<th valign="bottom">Comments</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr class="tbl even" valign="top"> | ||
<td class="detail"><a href="users/index.html">users</a></td> | ||
<td class="comment detail" style="display: table-cell;"></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
</div> | ||
<!-- /.box-body --> | ||
</div> | ||
</section> | ||
<!-- /.content --> | ||
|
||
</div> | ||
<!-- /.content-wrapper --> | ||
<footer class="main-footer"> | ||
<div> | ||
<div class="pull-right hidden-xs"> | ||
<a href="https://github.com/schemaspy/schemaspy" title="GitHub for SchemaSpy"><i class="fa fa-github-square fa-2x"></i></a> | ||
<a href="http://stackoverflow.com/questions/tagged/schemaspy" title="StackOverflow for SchemaSpy"><i class="fa fa-stack-overflow fa-2x"></i></a> | ||
</div> | ||
<strong>Generated by <a href="http://schemaspy.org/" class="logo-text"><i class="fa fa-database"></i> SchemaSpy 6.2.4</a></strong> | ||
</div> | ||
<!-- /.container --> | ||
</footer> | ||
</div> | ||
<!-- ./wrapper --> | ||
|
||
<!-- jQuery 2.2.3 --> | ||
<script src="bower/admin-lte/plugins/jQuery/jquery-2.2.3.min.js"></script> | ||
<script src="bower/admin-lte/plugins/jQueryUI/jquery-ui.min.js"></script> | ||
<!-- Bootstrap 3.3.5 --> | ||
<script src="bower/admin-lte/bootstrap/js/bootstrap.min.js"></script> | ||
<!-- DataTables --> | ||
<script src="bower/datatables.net/jquery.dataTables.min.js"></script> | ||
<script src="bower/datatables.net-bs/js/dataTables.bootstrap.min.js"></script> | ||
<script src="bower/datatables.net-buttons/dataTables.buttons.min.js"></script> | ||
<script src="bower/datatables.net-buttons-bs/js/buttons.bootstrap.min.js"></script> | ||
<script src="bower/datatables.net-buttons/buttons.html5.min.js"></script> | ||
<script src="bower/datatables.net-buttons/buttons.print.min.js"></script> | ||
<script src="bower/datatables.net-buttons/buttons.colVis.min.js"></script> | ||
<!-- SheetJS --> | ||
<script src="bower/js-xlsx/xlsx.full.min.js"></script> | ||
<!-- pdfmake --> | ||
<script src="bower/pdfmake/pdfmake.min.js"></script> | ||
<script src="bower/pdfmake/vfs_fonts.js"></script> | ||
<!-- SlimScroll --> | ||
<script src="bower/admin-lte/plugins/slimScroll/jquery.slimscroll.min.js"></script> | ||
<!-- FastClick --> | ||
<script src="bower/admin-lte/plugins/fastclick/fastclick.js"></script> | ||
<!-- Salvattore --> | ||
<script src="bower/salvattore/salvattore.min.js"></script> | ||
<!-- AnchorJS --> | ||
<script src="bower/anchor-js/anchor.min.js"></script> | ||
<!-- CodeMirror --> | ||
<script src="bower/codemirror/codemirror.js"></script> | ||
<script src="bower/codemirror/sql.js"></script> | ||
<!-- AdminLTE App --> | ||
<script src="bower/admin-lte/dist/js/app.min.js"></script> | ||
<script src=""></script> | ||
<script src="schemaSpy.js"></script> | ||
</body> | ||
</html> |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.