{"id":20038721,"url":"https://github.com/defra/flood-app","last_synced_at":"2026-03-04T22:30:58.491Z","repository":{"id":37823020,"uuid":"156529698","full_name":"DEFRA/flood-app","owner":"DEFRA","description":null,"archived":false,"fork":false,"pushed_at":"2026-02-27T10:42:33.000Z","size":12426,"stargazers_count":4,"open_issues_count":35,"forks_count":3,"subscribers_count":9,"default_branch":"master","last_synced_at":"2026-02-27T15:48:06.577Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://check-for-flooding.service.gov.uk/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DEFRA.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-11-07T10:29:07.000Z","updated_at":"2026-02-27T10:41:12.000Z","dependencies_parsed_at":"2024-11-07T18:21:02.974Z","dependency_job_id":"945aac2e-52d5-47dc-a106-4a1319439fd6","html_url":"https://github.com/DEFRA/flood-app","commit_stats":null,"previous_names":[],"tags_count":87,"template":false,"template_full_name":null,"purl":"pkg:github/DEFRA/flood-app","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fflood-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fflood-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fflood-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fflood-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DEFRA","download_url":"https://codeload.github.com/DEFRA/flood-app/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DEFRA%2Fflood-app/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30096721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T21:59:23.547Z","status":"ssl_error","status_checked_at":"2026-03-04T21:57:50.415Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-13T10:32:16.423Z","updated_at":"2026-03-04T22:30:58.471Z","avatar_url":"https://github.com/DEFRA.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Build status](https://github.com/DEFRA/flood-app/actions/workflows/ci.yml/badge.svg)[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_flood-app\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=DEFRA_flood-app)[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=DEFRA_flood-app\u0026metric=coverage)](https://sonarcloud.io/dashboard?id=DEFRA_flood-app)\n\n# flood-app\n\nThis is the front end application to check the flooding service\n\n## Getting started\n\n### Prerequisites\n\nRunning flood-db: https://github.com/DEFRA/flood-db\nRunning flood-gis: https://github.com/DEFRA/flood-gis\nRunning flood-service: https://github.com/DEFRA/flood-service\n\nNode.js v16.x.x\n\n### Testing the application\n\nBefore running tests, ensure that your environment variables are set.\n\n\n```\n$ npm i\n$ npm run test\n```\n\nFunctional testing: https://github.com/DEFRA/flood-service-tests-v2\n\n### Running the application\n\nBefore running the applciation, ensure that your environment variables are set.\n\n```\n$ npm i\n$ node index.js\n```\n\nGo to http://localhost:3009\n\n### Developing the application\n\nWhen making changes to the application, bear in mind that certain aspects and components are only updated when you perform the **npm run build** stage.\n\nIf your changes are not reflected in the browser/console, you should check this first.\n\n# Environment variables\n\nCreate a .env file at the root of the project to set your environment variables locally, which is especially useful during development. The [dotenv](https://www.npmjs.com/package/dotenv) package facilitates this by automatically loading these variables at application start. This approach is recommended as a simpler alternative to global settings, like those in .bashrc. \n\nFor DEFRA employees, examples of these environment variables are available in our private lfwconfig repository.\n\n| name     | description      | required | default |            valid            |             notes             |\n|----------|------------------|:--------:|---------|:---------------------------:|:-----------------------------:|\n| NODE_ENV | Node environment |    no    | production | development, dev, test, tst, production |                               |\n| FLOOD_APP_STAGE | Flavour of environment | no | '' | ||\n| PORT     | Port number      |    no    | 3009    |                             |                               |\n| FLOOD_APP_BING_KEY_MAP   | MS Bing Key  |    yes    |         |                             | For location search |\n| FLOOD_APP_BING_KEY_LOCATION   | MS Bing Key  |    yes    |         |                             | For location search |\n| FLOOD_APP_BING_URL   | MS Bing Location Search  |    yes    |         |                             | For location search |\n| FLOOD_APP_GEOSERVER_URL   | Geoserver  |    yes    |         |                             | For maps ows |\n| FLOOD_APP_SERVICE_URL   | flood-service  |    yes    |         |                             | For flood api |\n| FLOOD_APP_GA4_ID   | Google analytics 4 Id |    no    |         |                             |  |\n| FLOOD_APP_GTM_ID   | Google Tag Manager Id |    no    |         |                             |  |\n| FLOOD_APP_NRW_STATION_URL | NRW station search  | yes | https://rivers-and-seas.naturalresources.wales/Station/ | |\n| FLOOD_APP_SITE_URL   | Site Url  |    yes    | http://localhost:3009 |                             | For SEO metadata |\n| FLOOD_RISK_URL   | Flood risk Url  |    yes    |  |                             | To link to correct flood risk environment |\n| FLOOD_APP_FIS_URL   | Flood Information Service Url  |    yes    |  |                             | To link to correct flood information sevrvice environment |\n| FLOOD_APP_SESSION_PASSWORD | cookie password | yes | | |\n| FLOOD_APP_REDIS_HOST | redis cache host | no | | |  |\n| FLOOD_APP_REDIS_PORT | redis cache port | no | | |  |\n| FLOOD_APP_REDIS_PASSWORD | redis cache password | no | | | |\n| FLOOD_APP_LOCAL_CACHE | to cache or not | no | false | |  |\n| FLOOD_APP_GA_OPT_ID | google opt id | no | | |  |\n| FLOOD_APP_RATE_LIMIT_ENABLED | rate limit  | no | false | | If set to true then all rate limit envvars need to be valid |\n| FLOOD_APP_RATE_LIMIT_REQUESTS | rate limit  | no | | Number of total requests that can be made on a given path per user per period. Set to false to disable limiting requests per path per user. |  |\n| FLOOD_APP_RATE_LIMIT_EXPIRES_IN | rate limit  | no | | Time (in milliseconds) of period for number of total requests |  |\n| FLOOD_APP_RATE_LIMIT_WHITELIST | rate limit white-listed ip addresses | no | | Colon separated list of IPs to bypass rate limiting e.g. '1.1.1.1:2.2.2.2' |  |\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefra%2Fflood-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdefra%2Fflood-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdefra%2Fflood-app/lists"}