Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/defra/cyltfr-app
Check Your Long Term Flood Risk application
https://github.com/defra/cyltfr-app
Last synced: 6 days ago
JSON representation
Check Your Long Term Flood Risk application
- Host: GitHub
- URL: https://github.com/defra/cyltfr-app
- Owner: DEFRA
- License: other
- Created: 2024-06-24T14:25:49.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T13:42:44.000Z (21 days ago)
- Last Synced: 2024-10-29T16:13:07.963Z (21 days ago)
- Language: JavaScript
- Size: 67.9 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://sonarcloud.io/dashboard?id=DEFRA_cyltfr-app)
[](https://standardjs.com)
[](https://github.com/facebook/jest)
[](https://github.com/DEFRA/cyltfr-app/issues/)
[]()
[]()
[](http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3)
# Check Your Long Term Flood Risk Services Front end application (cyltfr-app)
Repo for the Check Your Long Term Flood service front end application.
## Prerequisites
Node v20.x
Docker v20.10.0+
### Build app
`npm run build`
### Start app
`npm start`
### Test app
`npm test`
# Environment variables (TODO: These are currently loaded via the config/server.json file not env vars)
| name | description | required | default | valid | notes |
|-----------------------------|-----------------------------------------|:---------:|-------------|:---------------------------:|-------|
| NODE_ENV | Node environment | no | development | development,test,production | |
| RISK_APP_HOST | Host server IP | yes | | | |
| PORT | Server port # | yes | | | |
| SERVICE_URL | Service API | yes | | | |
| SIMULATE_ADDRESS_SERVICE | Mocks address service for testing | no | false | | |
| DATA_VERSION | Which data version will be used for maps| no | 01 | | |
| HTTP_TIMEOUT_MS | Timeout in ms | yes | | | |
| G4_ANALYTICS_ACCOUNT | GA ID | no | | | |
| GTAG_MANAGER_ID | GTM ID | no | | | |
| FLOOD_WARNINGS_URL | Flood warning API | yes | | | |
| FLOOD_RISK_URL | Flood risk API | yes | | | |
| OS_POSTCODE_URL | OS postcode API | yes | | | |
| OS_MAPS_URL | OS map API | yes | | | |
| OS_SEARCH_KEY | OS search key | yes | | | |
| OS_MAPS_KEY | OS map key | yes | | | |
| OS_MAPS_SECRET | OS map secret key | yes | | | |
| OS_TOKEN_ENDPOINT | End point to OS OAuth token generation | no | https://api.os.uk/oauth2/token/v1 | | |
| OS_TOKEN_EXPIRY_TIME | Map token expiry time in ms | no |60 * 60 *1000| | |
| http_proxy | Proxy that is used for external calls by the service | no | | | |
| RATE_LIMIT_ENABLED | Enable limit on postcode requests | no | false | | |
| RATE_LIMIT_REQUESTS | Amount of requests per user | no | | | |
| RATE_LIMIT_EXPIRES_IN | Time user request limit expires | no | | | |
| RATE_LIMIT_WHITELIST | Limit enabled user exceptions | yes | [] | | |
| REDIS_CACHE_ENABLED | Redis cache storing enabled | no | false | | |
| REDIS_TLS | Redis cache requires TLS for connection | no | false | | |
| REDIS_CACHE_HOST | Redis linked AWS server URI | no | | | |
| REDIS_CACHE_PORT | Redis default port | no | 6379 | | |
| COOKIE_PASSWORD | Password to prevent exposing cookie data | yes | | | |
| FRIENDLY_CAPTCHA_ENABLED | Friendly Captcha robot check enabled | no | false | | |
| FRIENDLY_CAPTCHA_SITE_KEY | Key for site for Catcha check | no | | | |
| FRIENDLY_CAPTCHA_SECRET_KEY | Secret key for website captcha | no | | | |
| FRIENDLY_CAPTCHA_URL | Friendly Captcha API | no | | | |
| FRIENDLY_CAPTCHA_BYPASS | Friendly Capctha bypass key | no | | | |
| SESSION_TIMEOUT | Timeout for session cookies of 10 minutes | no | 10 | | |
| CACHE_ENABLED | If disabled external APIs will not be cached | no | true | | |
| ERRBIT_POST_ERRORS | Allow Errbit errors to be sent for post requests | yes | | | |
| ERRBIT_ENV | Option for info of of which environment is sent to Errbit | yes | | | |
| ERRBIT_KEY | Key for Errbit error logging | yes | | | |
| ERRBIT_HOST | Server IP for where Errbit is hosted | yes | | | |
| ERRBIT_PROXY | Errbit proxy | no | | | |
| ESRI_CLIENT_ID | ESRI Client ID | yes | | | |
| ESRI_CLIENT_SECRET | ESRI Client Secret | yes | | | |
# Running the application locally
`$ node index.js`
# Debugging the application in docker using vscode
First build the debug image using
`$ npm run container:builddebug`
Configure vscode using a debug configuration launch.json like
```json
{
"version": "0.2.0",
"configurations": [
{
"address": "0.0.0.0",
"name": "Attach",
"port": 9229,
"request": "attach",
"skipFiles": [
"/**"
],
"localRoot": "${workspaceFolder}",
"remoteRoot": "/home/node/app",
"type": "node"
}
]
}
```
Then you can run the container in debug mode using
`$ npm run container:debug`
or
`$ npm run cd`
This maps your source directory into the container, so that you can make changes locally and they'll be reflected in the container.
If you have auto-attach configured in vscode you might need to disable it for this to work.
When you have finished end the debug container using
`$ npm run container:stopdebug`
or
`$ npm run cx`
## Contributing to this project
Please read our [contribution guidelines](https://github.com/DEFRA/cyltfr-app/blob/develop/CONTRIBUTING.md)
## License
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
The following attribution statement MUST be cited in your products and applications when using this information.
Contains public sector information licensed under the Open Government license v3
### About the license
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.