Organics Info (ORI) - OMRR Transparency Initiative
Organics Info (ORI) shares information on authorized biosolids land application and compost facilities regulated under the Organic Matter Recycling Regulation (OMRR) in BC.
This project is part of a the OMRR Transparency Enhancement Initiative led by the Environmental Policy and Initiatives Branch (EPIB) in the Ministry of Environment and Climate Change Strategy.
Technologies used
We have architecture diagrams the document the technologies used:
- Typescript (https://www.typescriptlang.org/)
- React (https://react.dev/)
- Mui (https://mui.com/)
- Leaflet (https://leafletjs.com/)
- Node (https://nodejs.org/en/)
- OpenShift container platform cluster
Getting Started
Here is high-level documentation on the development of applications, use of GitHub, and Openshift in the Government of BC:
Running the application in local development environment
Pre-requisites:
- Node.js installed on the machine
- Access to OpenShift namespace for Organics Info (ORI) project
- OC CLI installed.(https://console.apps.silver.devops.gov.bc.ca/command-line-tools)
- .env file is created in the backend folder based on the .env.sample file, the values can be retrieved from secrets in OpenShift namespace.
Steps:
- Open terminal, do oc login and switch to the namespace where the application is deployed.
- Run the following command in terminal
oc port-forward service/nr-oracle-service 9080:80, this enables access to nr oracle service on port 9080 of local machine. - Run the following command in terminal
cd backend && npm install && npm run start:debug, this will start the backend application on port 3000. - Run the following command in terminal
cd frontend && npm install && npm run dev, this will start the frontend application on port 3001.
Contribution Guidelines
Follow the steps outlined in this repository to contribute: CONTRIBUTING.md.
License
Copyright 2024 Province of British Columbia. Code is released under the Apache License, Version 2.0.