{"id":27057286,"url":"https://github.com/bcgov/nr-peach","last_synced_at":"2025-04-05T11:18:23.721Z","repository":{"id":286211119,"uuid":"956832898","full_name":"bcgov/nr-peach","owner":"bcgov","description":"NR Permitting Exchange, Aggregation and Collection Hub","archived":false,"fork":false,"pushed_at":"2025-04-05T00:31:41.000Z","size":104,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-05T01:24:56.533Z","etag":null,"topics":["aggregation","collection","data-standard","dds","exchange","interoperability","json-schema","markdown","nodejs","nr-pit","nr-pmt","nrids","permitting","typescript","wlrs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.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":"2025-03-29T00:06:08.000Z","updated_at":"2025-04-05T00:31:45.000Z","dependencies_parsed_at":"2025-04-05T01:24:59.199Z","dependency_job_id":"70e6f71c-f03f-4907-97c6-21c0d7518a3d","html_url":"https://github.com/bcgov/nr-peach","commit_stats":null,"previous_names":["bcgov/nr-peach"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fnr-peach","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fnr-peach/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fnr-peach/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bcgov%2Fnr-peach/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bcgov","download_url":"https://codeload.github.com/bcgov/nr-peach/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247325685,"owners_count":20920715,"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":["aggregation","collection","data-standard","dds","exchange","interoperability","json-schema","markdown","nodejs","nr-pit","nr-pmt","nrids","permitting","typescript","wlrs"],"created_at":"2025-04-05T11:18:22.998Z","updated_at":"2025-04-05T11:18:23.700Z","avatar_url":"https://github.com/bcgov.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NR Permitting Exchange, Aggregation and Collection Hub\n\n[![Lifecycle:Experimental](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n\nTBD\n\n## Directory Structure\n\n```txt\n.github/                   - GitHub PR and Issue templates\n.vscode/                   - VSCode environment configurations\nsrc/                       - Node.js web application\n├── components/            - Components Layer\n├── controllers/           - Controller Layer\n├── db/                    - Database Layer\n├── interfaces/            - Typescript interface definitions\n├── middleware/            - Middleware Layer\n├── routes/                - Routes Layer\n├── services/              - Services Layer\n├── tests/                 - Node.js web application tests\n└── types/                 - Typescript type definitions\nbcgovpubcode.yml           - BCGov Repository Metadata\nCODE-OF-CONDUCT.md         - Code of Conduct\nCOMPLIANCE.yaml            - BCGov PIA/STRA compliance status\nCONTRIBUTING.md            - Contributing Guidelines\nLICENSE                    - License\nrenovate.json              - Mend Renovate configuration\nSECURITY.md                - Security Policy and Reporting\n```\n\n## Installation Guide\n\nThis section outlines how to quickly set up and run the app 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- Install Postgres 16.x or higher\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 migrate:latest\n```\n\nThis command ensures that your database schema is up-to-date.\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\ndesired 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\nscript 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## Getting Help or Reporting an Issue\n\nTo report bugs/issues/features requests, please file an\n[issue](https://github.com/bcgov/nr-peach/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\n```txt\nCopyright 2025 Province of British Columbia\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcgov%2Fnr-peach","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbcgov%2Fnr-peach","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbcgov%2Fnr-peach/lists"}