Emissions Collection & Monitor Plan System (ECMPS) Application

Description

EPA Clean Air Markets Division (CAMD) Emissions Collection & Monitor Plan System (ECMPS) website application supporting industry power plant facilities with their Part 75 regulatory reporting & compliance.

Getting Started

Follow these instructions to get the project up and running correctly.

Installing

1. Open a terminal and navigate to the directory where you wish to store the repository.
2. Clone the repository using one of the following git cli commands or using your favorit Git management software
   Using SSH

   $ git clone git@github.com:US-EPA-CAMD/easey-ecmps-ui.git
   

   Using HTTPS

   $ git clone https://github.com/US-EPA-CAMD/easey-ecmps-ui.git
   

3. Navigate to the projects root directory

   $ cd easey-ecmps-ui
   

4. Install package dependencies

   $ yarn install --ignore-engines
   

5. Initialize project to copy all the necessary Sass, image, font, and Javascript assets from the USWDS source code.

   $ npx gulp init
   

Building, Testing, & Running the application

From within the projects root directory run the following commands using the yarn command line interface

Run in development mode

$ yarn start:dev

Install/update package dependencies & run in development mode

$ yarn up

Unit tests

$ yarn test

Build

$ yarn build

Run in production mode

$ yarn start

Environment Variables

Environment variables need to be prefixed by VITE in order for the variables to be accessible on the process.env object in JavaScript.

To run application on a specific route path other than root...

• PUBLIC_URL: https://((host))/((path))
• VITE_EASEY_ECMPS_UI_PATH: /((path))

Required by the OIDC provider for Authentication/Authorization.

• VITE_EASEY_ECMPS_UI_CDX_HOW_TO_GET_ACCESS_PATH=((CBS Faq URL))
• VITE_EASEY_ECMPS_UI_OIDC_CLIENT_ID=((Oidc Configured Client ID))
• VITE_EASEY_ECMPS_UI_OIDC_AUTH_ENDPOINT=((OIDC Auth endpoint))
• VITE_EASEY_ECMPS_UI_OIDC_AUTH_RESPONSE_TYPE=code
• VITE_EASEY_ECMPS_UI_OIDC_AUTH_RESPONSE_MODE=form_post
• VITE_EASEY_ECMPS_UI_OIDC_AUTH_SCOPES='openid profile email phone address offline_access'
• VITE_EASEY_ECMPS_UI_CDX_SIGNUP_MIGRATE_URL=((Cdx Url))

REST API URL's required by the application...

• VITE_EASEY_AUTH_API: https://((host))/api/auth-mgmt
• VITE_EASEY_MDM_API: https://((host))/api/master-data-mgmt
• VITE_EASEY_FACILITIES_API: https://((host))/api/facility-mgmt
• VITE_EASEY_EMISSIONS_API: https://((host))/api/emissions-mgmt
• VITE_EASEY_MONITOR_PLAN_API: https://((host))/api/monitor-plan-mgmt

Other application environment variables:

• VITE_EASEY_ECMPS_UI_HOST: ((host))
• VITE_EASEY_ECMPS_UI_API_KEY=((api key))
• VITE_EASEY_ECMPS_UI_CLIENT_ID=((client id))
• VITE_EASEY_ECMPS_UI_CLIENT_SECRET=((client secret))
• VITE_EASEY_ECMPS_UI_ENV: ((environment))
• VITE_EASEY_ECMPS_UI_INACTIVITY_DURATION_MINUTES: ((inactivityDurationMinutes))
• VITE_EASEY_ECMPS_UI_ACTIVITY_POLLING_FREQUENCY_SECONDS: ((activityPollingFrequencySeconds))

Additional Environment Variable instructions found here.

License & Contributing

This project is licensed under the MIT License. We encourage you to read this project’s License, Contributing Guidelines, and Code of Conduct.

Disclaimer

The United States Environmental Protection Agency (EPA) GitHub project code is provided on an "as is" basis and the user assumes responsibility for its use. EPA has relinquished control of the information and no longer has responsibility to protect the integrity , confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by EPA. The EPA seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by EPA or the United States Government.