NR Permitting Exchange, Aggregation and Collection Hub

TBD

Directory Structure

.github/                   - GitHub PR and Issue templates
.vscode/                   - VSCode environment configurations
src/                       - Node.js web application
├── components/            - Components Layer
├── controllers/           - Controller Layer
├── db/                    - Database Layer
├── interfaces/            - Typescript interface definitions
├── middleware/            - Middleware Layer
├── routes/                - Routes Layer
├── services/              - Services Layer
├── tests/                 - Node.js web application tests
└── types/                 - Typescript type definitions
bcgovpubcode.yml           - BCGov Repository Metadata
CODE-OF-CONDUCT.md         - Code of Conduct
COMPLIANCE.yaml            - BCGov PIA/STRA compliance status
CONTRIBUTING.md            - Contributing Guidelines
LICENSE                    - License
renovate.json              - Mend Renovate configuration
SECURITY.md                - Security Policy and Reporting

Installation Guide

This section outlines how to quickly set up and run the app locally.

Prerequisites

You will need the following installed on your machine before you can proceed:

• Install Node.js 22 LTS or higher
• Install VSCode
• Install VSCode Recommended Extensions
  • This can be done by searching @recommended in the Extensions tab, and then clicking the Install Workspace Recommended Extensions button.
• Install Postgres 16.x or higher

Install

npm ci

This command installs the dependencies as defined by the lockfile.

Environment Variables

cp .env.default .env

If you do not have a .env file in the root directory, create a copy of the .env.default and modify as necessary.

Run Local Development

npm run migrate:latest

This command ensures that your database schema is up-to-date.

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Static Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning

Releasing a version requires the following actions to be done in order:

1. Run npm version with argument patch, minor or major depending on the desired outcome (e.g. npm version minor).
2. Run npm run version with the semver version to be published (e.g. npm run version 0.1.0). This will create a new Docusaurus version, and run a script to align all the schema references appropriately.

Note: You may run npm run postversion directly in the event you need to manually align all the schema references.

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 2025 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.