bcgov · dbarkowsky · Sep 23, 2024 · Sep 23, 2024 · Sep 23, 2024 · Sep 23, 2024
@@ -1,4 +1,4 @@
-# Old and New PIMS
+# API
 API_HTTP_PORT=
 
 # For Postgres Container
@@ -13,10 +13,11 @@ FRONTEND_URL=
 BACKEND_URL=
 
 # Express Keycloak Settings
-
 SSO_CLIENT_ID= # Keycloak client_id
 SSO_CLIENT_SECRET= # Keycloak client_secret
 SSO_AUTH_SERVER_URL= # Keycloak auth URL
+DEBUG= # (optional) Set to 'true' to get useful debug statements in api console.
+VERBOSE_DEBUG= # (optional) Set to 'true' to get extra details from DEBUG.
 
 # CSS Keycloak API
 CSS_API_CLIENT_ID= # Keycloak CSS API Service Account client_id
@@ -48,3 +49,7 @@ LTSA_INTEGRATOR_USERNAME=
 LTSA_INTEGRATOR_PASSWORD=
 LTSA_USERNAME=
 LTSA_PASSWORD=
+
+# Debug Options
+RAW_TYPEORM_DEBUG= # Boolean. Will not print queries to logger
+LOG_QUERIES= # Boolean 
@@ -3,19 +3,18 @@
 
 # Declare files that will always have LF line endings on checkout.
 text eol=lf
-*.cs text eol=lf
-*.csproj text eol=lf
-*.sln text eol=lf
 *.sql text eol=lf
 *.tsx text eol=lf
 *.ts text eol=lf
 *.js text eol=lf
+*.mjs text eol=lf
+*.cjs text eol=lf
 *.jsx text eol=lf
 *.css text eol=lf
 *.scss text eol=lf
 *.sh text eol=lf
 *.md text eol=lf
 *.json text eol=lf
+*.yaml text eol=lf
+*.yml text eol=lf
 *.conf text eol=lf
-**/s2i/bin/* text eol=lf
-**/root/**/* text eol=lf
@@ -1,65 +1,71 @@
-[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
-[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/bcgov/pims/issues)
-![API (.Net Core)](<https://github.com/bcgov/PIMS/workflows/API%20(.NET%20Core)/badge.svg?branch=dev>)
-![APP (React)](<https://github.com/bcgov/PIMS/workflows/APP%20(React)/badge.svg?branch=dev>)
+# Property Inventory Management System (PIMS)
 
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
 [![img](https://img.shields.io/badge/Lifecycle-Stable-97ca00)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
 
-# PIMS
+PIMS offers an inventory management system that supports the Strategic Real Estate Services (SRES) branch of the Real Property Division (RPD) in managing and overseeing the disposal of assets surplus to government. It aids staff in optimizing the benefits of managing public real-estate assets for government and BC citizens, and aims to be a trusted source for accurate information on government-owned titled property.
 
-Property Inventory Management System
+The system supports the management of titled properties through the government property ownership life cycle from acquisition to disposal (transfer to another ministry or sale outside of the government). This includes the ability to manage internal workflows. PIMS assists with the collection, analysis, and reporting of spatial data and related asset information from multiple data sources.
 
-## Introduction
+## Why PIMS?
 
-Strategic Real Estate Services (SRES), comprised of professionals from a variety of backgrounds (sales, marketing, First Nations consultation, environmental management and communications) was formed to dispose of assets surplus to government, in order to help government meet its commitment to balance the provincial budget, and to generate economic activity in communities throughout BC. The SRES team is tasked with coordinating the province-wide management of this initiative ensuring that all issues are addressed appropriately and the return to government is maximized.
+Strategic Real Estate Services (SRES), comprised of professionals from a variety of backgrounds (sales, marketing, First Nations consultation, environmental management and communications) was formed to dispose of assets surplus to government in order to help government meet its commitment to balance the provincial budget and to generate economic activity in communities throughout BC. The SRES team is tasked with coordinating the province-wide management of this initiative, ensuring that all issues are addressed appropriately and that the return to government is maximized.
 
 SRES is responsible for:
 
 - Maintaining a complete inventory of the Province’s real estate assets
-- Tracking Ministry organizations compliance with policies related to disposition of real estate assets
+- Tracking Ministry organizations' compliance with policies related to disposition of real-estate assets
 - Marketing property internally for repurposing (transfer to another ministry)
 - Oversight of sales process from pre-marketing to completion
-- First Nations Consultation real estate development and dispositions
-- Providing strategic real estate analysis and advice to Ministries and Broader Public Sectors
+- First Nations Consultation on real estate development and dispositions
+- Providing strategic real estate analysis and advice to ministries and broader public sectors
 - Reporting to Treasury Board
 
-To support SRES’s overall strategic real estate initiatives a modern Information Management System is required that will aid in strategic decision making, support its client Ministries and the Broader Public Sector, and remain compliant with current Inventory Policies (CPPM Policy Chapter 8: Asset Management). Ideally the system will be flexible to allow for ad hoc customized reporting and adaptable to support unforeseen future real estate strategies.
-
-## Problem Statement
-
-The Province is not able to make the most informed, timely, and strategic decisions on the optimal use of its real property assets on behalf of the people and priorities of British Columbia.
+To support SRES’s overall strategic real estate initiatives, a modern Inventory Management System was required that would aid in strategic decision making, support its client ministries and the Broader Public Sector, and remain compliant with current Inventory Policies (CPPM Policy Chapter 8: Asset Management). The system must be flexible to allow for ad hoc customized reporting and adaptable to support unforeseen future real-estate strategies.
 
-## Hypothesis
+## Documentation
 
-If we have a modern easy to use system built in collaboration with, and for the benefit of, clients they will want to use it to provide Strategic Real Estate Services (SRES) with the data required to support real time executive decision making and to remain compliant with core policy.
+All public-facing documentation is found in the [GitHub Wiki](https://github.com/bcgov/PIMS/wiki). Here are some common pages you may want to visit:
 
-## Goal
+- [Development](https://github.com/bcgov/PIMS/wiki/Development)
+- [Glossary](https://github.com/bcgov/PIMS/wiki/Glossary)
+- [PIMS Team](https://github.com/bcgov/PIMS/wiki/PIMS-Development-Team)
 
-The goal of the PIMS project team is to create a Geo-spatial Client Relationship Management System to support the Strategic Real Estate Services branch of Real Property Division to manage and oversee the disposal of assets surplus to government, optimize the benefits to the government and citizens of BC related to the management of public real estate assets, and be a trusted source for accurate information for Government owned titled property.
+## Report an Issue
 
-The system will support the management of titled properties through the government property ownership life cycle from acquisition to disposal (transfer to another ministry or sale outside of the government). This would include the ability to manage internal workflows. PIMS will be capable of collection, analysis, and reporting of spatial data and related asset information from multiple data sources.
+Having issues with PIMS? See a problem in the GitHub repository?
 
-Ideally reporting and query requirements would allow SRES staff to run technical detailed reports through the GIS and linked database. Simple query, collaboration and reporting should be available to non-technical users such as external stakeholders.
-
-Objectives include:
-
-- Increase the total amount of properties in the inventory Map
-- Ensure data validation occurs at time of project submission – BC Assessment and/or Land Title Survey Authority
-- Increase client satisfaction with system
-- Allow for portals for clients to add, edit, and report on properties in the system
-- Accurate, customizable, instant financial reporting
-- Seamless data migration from clients to PIMS
+Report your issue using the [Issues](https://github.com/bcgov/PIMS/issues/new/choose) page. Fill out the form and report your findings to help improve PIMS.
 
 ## Development
 
-> We are actively adding new features and enhancements.
-
-Read the documentation [here](https://github.com/bcgov/PIMS/wiki)
+PIMS is primarily in its maintenance phase. Security and stability updates will continue to be addressed, but additional features are not actively being developed.
+
+If you need to start an instance of PIMS on your local machine, see the [Development](https://github.com/bcgov/PIMS/wiki/Development) page.
+
+## Directory
+
+| Item | Description |
+| --- | --- |
+|`.github`| Files related to GitHub. Includes workflows, templates, etc. |
+|`database`| Files related to PostgreSQL. May include documentation aids and database-related scripts. |
+|`express-api`| The Express API for PIMS. |
+|`react-app`|The React/Vite frontend for PIMS.|
+|`tools`| Manually run scripts, security tools, etc.|
+|`.codeclimate.yml`| Configuration file for Code Climate checks.|
+|`.env-template`| The template file for locally created `.env` files.|
+|`.gitignore`|File that defines exclusions for git tracking.|
+|`.gitattributes`|Defines end of line requirements for files.|
+|`CODE_OF_CONDUCT.md`| A set of standards and guidelines for contributors to PIMS.|
+|`COMPLIANCE.yaml`|Recording of PIA and STRA dates.|
+|`LICENSE`|The Apache 2.0 license documentation.|
+|`README.md`|The README file containing this information.|
+|`docker-compose.yml`|A Docker compose file that creates containers for the PIMS application. |
 
 ## License
 
-```
-Copyright 2020 Province of British Columbia
+```md
+Copyright 2024 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.