README
¶
dp-frontend-feedback-controller
To allow users to provide feedback about the ONS website
Getting started
- Run
dis-design-system-goin a separate shell to generate static assets (css/js) - To start the service use make,
make debug
Run service in feedback stack:
- Run feedback stack
Dependencies
- Run a local mail server to receive feedback if not running the feedback stack
- No further dependencies other than those defined in
go.mod
Tools
To run some of our tests you will need additional tooling:
Audit
We use dis-vulncheck to do auditing, which you will need to install.
Linting
We use v2 of golangci-lint, which you will need to install.
Configuration
| Environment variable | Default | Description |
|---|---|---|
| API_ROUTER_URL | http://localhost:23200/v1 | The URL of the dp-api-router |
| BIND_ADDR | localhost:25200 | The host and port to bind to |
| CENSUS_TOPIC_ID | 4445 | The census topic id |
| DEBUG | false | Enable debug mode |
| ENABLE_CENSUS_TOPIC_SUBSECTION | false | Enable census topic subsection |
| ENABLE_NEW_NAVBAR | false | Enable new navigation bar |
| FEEDBACK_FORM_MAX_BYTES | 64kb | Byte value for feedback form responses |
| GRACEFUL_SHUTDOWN_TIMEOUT | 5s | The graceful shutdown timeout in seconds (time.Duration format) |
| HEALTHCHECK_INTERVAL | 30s | Time between self-healthchecks (time.Duration format) |
| HEALTHCHECK_CRITICAL_TIMEOUT | 90s | Time to wait until an unhealthy dependent propagates its state to make this app unhealthy (time.Duration format) |
| IS_PUBLISHING_MODE | false | |
| PATTERN_LIBRARY_ASSETS_PATH | "" | Pattern library location |
| SERVICE_AUTH_TOKEN | "" | Service authorisation token |
| SITE_DOMAIN | localhost | |
| SUPPORTED_LANGUAGES | []string{"en", "cy"} | Supported languages |
| OTEL_EXPORTER_OTLP_ENDPOINT | localhost:4317 | Endpoint for OpenTelemetry service |
| OTEL_SERVICE_NAME | dp-frontend-feedback-controller | Label of service for OpenTelemetry service |
| OTEL_BATCH_TIMEOUT | 5s | Timeout for OpenTelemetry |
| OTEL_ENABLED | false | Feature flag to enable OpenTelemetry |
Contributing
See CONTRIBUTING for details.
License
Copyright © 2023, Office for National Statistics (https://www.ons.gov.uk)
Released under MIT license, see LICENSE for details.
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
assets in locale and templates folders are converted into Go source code with go-bindata the data.go file in this package is auto generated through the generate-dev and generate-prod tasks in the Makefile
|
assets in locale and templates folders are converted into Go source code with go-bindata the data.go file in this package is auto generated through the generate-dev and generate-prod tasks in the Makefile |
|
features
|
|
Click to show internal directories.
Click to hide internal directories.