Manages facility and unit data for the EPA CAMD Business Systems. The facilities API endpoints returns a list of all the regulated facilities/units and their associated attributes. Each facility in the list includes attributes such as monitoring configurations, monitor locations, associated units/stacks, unit types, unit fuels, & control technologies.
Follow these instructions to get the project up and running correctly.
- Open a terminal and navigate to the directory where you wish to store the repository.
- Clone the repository using one of the following git cli commands or using your favorit Git management software
Using SSHUsing HTTPS$ git clone [email protected]:US-EPA-CAMD/easey-facilities-api.git$ git clone https://github.com/US-EPA-CAMD/easey-facilities-api.git - Navigate to the projects root directory
$ cd easey-facilities-api - Install package dependencies
$ yarn install
The Facilities API uses a number of environment variables to properly configure the api. The following is the list of configureble values and their default setting.
| Typescript Var Name | Environment Var Name | Default Value | Comment |
|---|---|---|---|
| name | N/A | facilities-api | Fixed value |
| host | EASEY_FACILITIES_API_HOST | localhost | Configurable |
| port | EASEY_FACILITIES_API_PORT | 8020 | Configurable |
| path | EASEY_FACILITIES_API_PATH | facilities-mgmt | Configurable |
| title | EASEY_FACILITIES_API_TITLE | Facilities Management | Configurable |
| description | EASEY_FACILITIES_API_DESCRIPTION | Facility management API endpoints for power sector facilities and their attributes (e.g. units, stacks, and owners) | Configurable |
| env | EASEY_FACILITIES_API_ENV | local-dev | Configurable |
| enableApiKey | EASEY_FACILITIES_API_ENABLE_API_KEY | false | Configurable |
| secretToken | EASEY_FACILITIES_API_SECRET_TOKEN | *** | Dynamically set by CI/CD workflow |
| enableSecretToken | EASEY_FACILITIES_API_ENABLE_SECRET_TOKEN | false | Configurable |
| enableCors | EASEY_FACILITIES_API_ENABLE_CORS | true | Configurable |
| enableGlobalValidationPipes | EASEY_FACILITIES_API_ENABLE_GLOBAL_VALIDATION_PIPE | true | Configurable |
| version | EASEY_FACILITIES_API_VERSION | v0.0.0 | Dynamically set by CI/CD workflow |
| published | EASEY_FACILITIES_API_PUBLISHED | local | Dynamically set by CI/CD workflow |
| enableDebug | EASEY_FACILITIES_API_ENABLE_DEBUG | false | Configurable |
| perPageLimit | EASEY_FACILITIES_API_PAGINATION_MAX_PER_PAGE | 500 | Configurable |
| apiHost | EASEY_API_GATEWAY_HOST | api.epa.gov/easey/dev | Configurable |
Database credentials are injected into the cloud.gov environments as part of the CI/CD deployment process therefore they do not need to be configured. However, when running locally for local development the following environment variables are required to be configured using a local .env file in the root of the project. PLEASE DO NOT commit the .env file to source control.
- EASEY_FACILITIES_API_ENABLE_DEBUG=true|false
- EASEY_FACILITIES_API_ENABLE_API_KEY=true|false
- IF ABOVE IS TRUE THEN SET
- EASEY_FACILITIES_API_KEY={ask project dev/tech lead}
- IF ABOVE IS TRUE THEN SET
- EASEY_FACILITIES_API_ENABLE_SECRET_TOKEN=true|false
- IF ABOVE IS TRUE THEN SET
- EASEY_FACILITIES_API_SECRET_TOKEN={ask project dev/tech lead}
- IF ABOVE IS TRUE THEN SET
Please refer to our Getting Started instructions on how to configure the following environment variables & connect to the database.
- EASEY_DB_HOST
- EASEY_DB_PORT
- EASEY_DB_NAME
- EASEY_DB_USER
- EASEY_DB_PWD
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
Please refer to the Facilities Management API Swagger Documentation for descriptions of the endpoints.
Dev Environment | Test Environment | Performance Environment | Beta Environment | Staging Environment
This project is licensed under the MIT License. We encourage you to read this project’s License, Contributing Guidelines, and Code of Conduct.
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.