{"id":21821988,"url":"https://github.com/bcgov/nr-pies","last_synced_at":"2026-04-04T16:34:06.399Z","repository":{"id":263657131,"uuid":"870815306","full_name":"bcgov/nr-pies","owner":"bcgov","description":"An easy as pie way to exchange standardized permitting information.","archived":false,"fork":false,"pushed_at":"2025-03-11T17:28:18.000Z","size":4219,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-11T18:28:48.586Z","etag":null,"topics":["data-standard","docusaurus","interoperability","json-schema","markdown","mermaidjs","nodejs","nr-pmt","nrids","permitting","react","specification","typescript","wlrs"],"latest_commit_sha":null,"homepage":"https://bcgov.github.io/nr-pies/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bcgov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE-OF-CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-10T18:05:49.000Z","updated_at":"2025-03-11T17:27:37.000Z","dependencies_parsed_at":"2024-11-19T18:53:50.893Z","dependency_job_id":"22affbea-a8b8-4779-9047-f890286dcd40","html_url":"https://github.com/bcgov/nr-pies","commit_stats":null,"previous_names":["bcgov/nr-pies"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fnr-pies","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fnr-pies/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fnr-pies/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fnr-pies/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bcgov","download_url":"https://codeload.github.com/bcgov/nr-pies/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244787014,"owners_count":20510041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["data-standard","docusaurus","interoperability","json-schema","markdown","mermaidjs","nodejs","nr-pmt","nrids","permitting","react","specification","typescript","wlrs"],"created_at":"2024-11-27T17:11:53.395Z","updated_at":"2025-12-30T23:59:47.795Z","avatar_url":"https://github.com/bcgov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NR Permitting Interoperability Exchange Specification\n\n[![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)\n[![Powered By](https://img.shields.io/badge/Powered%20By-Docusaurus-3ECC5F?logo=docusaurus)](https://docusaurus.io/)\n\nAn easy-as-pie way to exchange standardized permitting information. 🥧\n\nThis website is built using [Docusaurus](https://docusaurus.io/), a modern\nstatic website generator.\n\n## Directory Structure\n\n```txt\n.github/                   - GitHub PR and Issue templates\n.vscode/                   - VSCode environment configurations\nblog/                      - Blog Content Root (Dormant)\ndocs/                      - Docs Content Root\n├── docusaurus/            - Docusaurus Tutorials\n├── intro/                 - PIES General Information\n├── spec/                  - PIES Technical Specification\n│   ├── concept/           - PIES Concept Maps\n│   ├── data/              - PIES Data Type Schemas\n│   ├── message/           - PIES Message Type Schemas\n│   ├── resource/          - PIES Resource Type Schemas\n│   └── tags.yaml          - Canonical documentation tags\n├── src/                   - Docusaurus Source Code\n└── static/                - Site Static Assets\nbcgovpubcode.yml           - BCGov Repository Metadata\nCODE-OF-CONDUCT.md         - Code of Conduct\nCOMPLIANCE.yaml            - BCGov PIA/STRA compliance status\nCONTRIBUTING.md            - Contributing Guidelines\ndocusaurus.config.ts       - Main Docusaurus configuration\nLICENSE                    - License (Code)\nLICENSE-docs               - License (Documentation)\nrenovate.json              - Mend Renovate configuration\nSECURITY.md                - Security Policy and Reporting\nsidebars.ts                - Main Docusaurus sidebar configuration\nversionUtils.mts           - PIES Versioning Utilities\n```\n\n## Installation Guide\n\nThis section outlines how to quickly set up and run the Docusaurus site locally.\n\n### Prerequisites\n\nYou will need the following installed on your machine before you can proceed:\n\n- Install [Node.js 22 LTS](https://nodejs.org) or higher\n- Install [VSCode](https://code.visualstudio.com)\n- Install VSCode [Recommended Extensions](https://code.visualstudio.com/docs/editor/extension-marketplace#_workspace-recommended-extensions)\n  - This can be done by searching `@recommended` in the Extensions tab, and then\n    clicking the `Install Workspace Recommended Extensions` button.\n\n### Install\n\n```sh\nnpm ci\n```\n\nThis command installs the dependencies as defined by the lockfile.\n\n### Run Local Development\n\n```sh\nnpm run start\n```\n\nThis command starts a local development server and opens up a browser window.\nMost changes are reflected live without having to restart the server.\n\n### Static Build\n\n```sh\nnpm run build\n```\n\nThis command generates static content into the `build` directory and can be\nserved using any static contents hosting service.\n\n### Versioning\n\nReleasing a version requires the following actions to be done in order:\n\n1. Run `npm version` with argument `patch`, `minor` or `major` depending on the\n   desired outcome (e.g. `npm version minor`).\n2. Run `npm run version` with the semver version to be published (e.g.\n   `npm run version 0.1.0`). This will create a new Docusaurus version, and run a\n   script to align all the schema references appropriately.\n\n_Note: You may run `npm run postversion` directly in the event you need to\nmanually align all the schema references._\n\n---\n\n### Deployment Notes\n\nThe following steps are not necessary in order to contribute to PIES as this\nrepository contains a dedicated CI/CD pipeline.\n\nUsing SSH:\n\n```sh\nUSE_SSH=true npm run deploy\n```\n\nNot using SSH:\n\n```sh\nGIT_USER=\u003cYour GitHub username\u003e npm run deploy\n```\n\nIf you are using GitHub pages for hosting, this command is a convenient way to\nbuild the website and push to the `gh-pages` branch.\n\n## Getting Help or Reporting an Issue\n\nTo report bugs/issues/features requests, please file an\n[issue](https://github.com/bcgov/nr-pies/issues).\n\n## How to Contribute\n\nIf you would like to contribute, please see our [contributing](CONTRIBUTING.md)\nguidelines.\n\nPlease note that this project is released with a\n[Contributor Code of Conduct](CODE-OF-CONDUCT.md). By participating in this\nproject you agree to abide by its terms.\n\n## License\n\nThis repository is dual licensed.\n\n- _Software or code_ by the Province of British Columbia is licensed under an\n  [AGPL v3 License](./LICENSE)\n  [![AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)\n\n  ```txt\n  NR Permitting Interoperability Exchange Specification\n  Copyright 2024 Province of British Columbia\n\n  This program is free software: you can redistribute it and/or modify\n  it under the terms of the GNU Affero General Public License as published\n  by the Free Software Foundation, either version 3 of the License, or\n  (at your option) any later version.\n\n  This program is distributed in the hope that it will be useful,\n  but WITHOUT ANY WARRANTY; without even the implied warranty of\n  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n  GNU Affero General Public License for more details.\n\n  You should have received a copy of the GNU Affero General Public License\n  along with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n  ```\n\n- _Documentation_ by the Province of British Columbia is licensed under a\n  [Creative Commons Attribution 4.0 International License](./LICENSE-docs)\n  [![Creative Commons Attribution 4.0 International License](https://i.creativecommons.org/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcgov%2Fnr-pies","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbcgov%2Fnr-pies","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcgov%2Fnr-pies/lists"}