README.md

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 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:

• "Working in github.com/bcgov" Cheatsheet
• DevHub DC Developer guide
• DevHub Openshift documentation

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:
  • NR_ORACLE_SERVICE_URL=http://localhost:9080
  • NR_ORACLE_SERVICE_KEY value is the apiKey value in the nr-oracle-service dev project
  • The OS_ values can be found in the nr-epd-organics-info-prod project

Steps:

1. Open a terminal, run the oc login command and switch to the namespace where the application is deployed.
   • The oc login command can be found by logging into OpenShift
   • Clicking on your name in the top right corner and choose Copy login command
   • Then choose Developer Log In and click Display Token
   • Then copy the oc login ... command
2. 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.
3. Run the following command in terminal cd backend && npm install && npm run start:debug, this will start the backend application on port 3000.
4. 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.