https://github.com/bcgov/nr-peach
NR Permitting Exchange, Aggregation and Collection Hub
https://github.com/bcgov/nr-peach
aggregation collection data-standard dds exchange interoperability json-schema markdown nodejs nr-pit nr-pmt nrids permitting typescript wlrs
Last synced: about 1 year ago
JSON representation
NR Permitting Exchange, Aggregation and Collection Hub
- Host: GitHub
- URL: https://github.com/bcgov/nr-peach
- Owner: bcgov
- License: apache-2.0
- Created: 2025-03-29T00:06:08.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-05T00:31:41.000Z (about 1 year ago)
- Last Synced: 2025-04-05T01:24:56.533Z (about 1 year ago)
- Topics: aggregation, collection, data-standard, dds, exchange, interoperability, json-schema, markdown, nodejs, nr-pit, nr-pmt, nrids, permitting, typescript, wlrs
- Language: TypeScript
- Homepage:
- Size: 102 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE-OF-CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# NR Permitting Exchange, Aggregation and Collection Hub
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[](LICENSE)
TBD
## Directory Structure
```txt
.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](https://nodejs.org) or higher
- Install [VSCode](https://code.visualstudio.com)
- Install VSCode [Recommended Extensions](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-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
```sh
npm ci
```
This command installs the dependencies as defined by the lockfile.
### Run Local Development
```sh
npm run migrate:latest
```
This command ensures that your database schema is up-to-date.
```sh
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
```sh
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](https://github.com/bcgov/nr-peach/issues).
## How to Contribute
If you would like to contribute, please see our [contributing](CONTRIBUTING.md)
guidelines.
Please note that this project is released with a
[Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this
project you agree to abide by its terms.
## License
```txt
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.
```