Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bcgov/nr-pies
An easy as pie way to exchange standardized permitting information.
https://github.com/bcgov/nr-pies
data-standard docusaurus interoperability json-schema markdown mermaidjs nodejs nr-pmt nrids permitting react specification typescript wlrs
Last synced: 8 days ago
JSON representation
An easy as pie way to exchange standardized permitting information.
- Host: GitHub
- URL: https://github.com/bcgov/nr-pies
- Owner: bcgov
- License: agpl-3.0
- Created: 2024-10-10T18:05:49.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-21T17:57:19.000Z (12 days ago)
- Last Synced: 2025-01-21T18:45:30.669Z (12 days ago)
- Topics: data-standard, docusaurus, interoperability, json-schema, markdown, mermaidjs, nodejs, nr-pmt, nrids, permitting, react, specification, typescript, wlrs
- Language: TypeScript
- Homepage: https://bcgov.github.io/nr-pies/
- Size: 4.51 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
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 Interoperability Exchange Specification
[](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
[](https://docusaurus.io/)
An easy as pie way to exchange standardized permitting information. 🥧
This website is built using [Docusaurus](https://docusaurus.io/), a modern
static website generator.
## Directory Structure
```txt
.github/ - GitHub PR and Issue templates
.vscode/ - VSCode environment configurations
blog/ - Blog Content Root (Dormant)
docs/ - Docs Content Root
├── docusaurus/ - Docusaurus Tutorials
├── intro/ - PIES General Information
├── spec/ - PIES Technical Specification
│ ├── concept/ - PIES Concept Maps
│ ├── data/ - PIES Data Type Schemas
│ ├── message/ - PIES Message Type Schemas
│ ├── resource/ - PIES Resource Type Schemas
│ └── tags.yaml - Canonical documentation tags
├── src/ - Docusaurus Source Code
└── static/ - Site Static Assets
bcgovpubcode.yml - BCGov Repository Metadata
CODE-OF-CONDUCT.md - Code of Conduct
COMPLIANCE.yaml - BCGov PIA/STRA compliance status
CONTRIBUTING.md - Contributing Guidelines
docusaurus.config.ts - Main Docusaurus configuration
LICENSE - License (Code)
LICENSE-docs - License (Documentation)
renovate.json - Mend Renovate configuration
SECURITY.md - Security Policy and Reporting
sidebars.ts - Main Docusaurus sidebar configuration
versionUtils.mts - PIES Versioning Utilities
```
## Installation Guide
This section outlines how to quickly set up and run the Docusaurus site 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
```sh
npm ci
```
This command installs the dependencies as defined by the lockfile.
### Run Local Development
```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._
---
### Deployment Notes
The following steps are not necessary in order to contribute to PIES as this
repository contains a dedicated CI/CD pipeline.
Using SSH:
```sh
USE_SSH=true npm run deploy
```
Not using SSH:
```sh
GIT_USER= npm run deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to
build the website and push to the `gh-pages` branch.
## Getting Help or Reporting an Issue
To report bugs/issues/features requests, please file an
[issue](https://github.com/bcgov/nr-pies/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
This repository is dual licensed.
- _Software or code_ by the Province of British Columbia is licensed under an
[AGPL v3 License](./LICENSE)
[](https://www.gnu.org/licenses/agpl-3.0)
```txt
NR Permitting Interoperability Exchange Specification
Copyright 2024 Province of British Columbia
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
```
- _Documentation_ by the Province of British Columbia is licensed under a
[Creative Commons Attribution 4.0 International License](./LICENSE-docs)
[](http://creativecommons.org/licenses/by/4.0/)