Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/update libraries and readme #237

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Feature/update libraries and readme #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
523d7e4
Update readme
dhee-tree Dec 3, 2024
34bea77
Update sixteens and design system versions
dhee-tree Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 34 additions & 34 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
dp-frontend-homepage-controller
================
# dp-frontend-homepage-controller

### Getting started
## Getting started

To run this service

1. Run sixteens locally using `npm run dev`
2. Run `make debug` to start the service on <http://localhost:24400>

### Dependencies

- sixteens - Serves CSS and JS for the page
- golang 1.23.x
- golang 1.23.x
- No further dependencies other than those defined in `go.mod`

### Configuration

| Config | Description | Default |
|-------------------------------------|----------------------------------------------------------------------------------------|-------------------------------------------|
| API_ROUTER_URL | The URL of the [dp-api-router](https://github.com/ONSdigital/dp-api-router) | http://localhost:23200/v1 |
| BIND_ADDR | The Port to run on | :24400 |
| CACHE_CENSUS_TOPICS_UPDATE_INTERVAL | Duration for census topic cache updates | 1 minute |
| CACHE_NAVIGATION_UPDATE_INTERVAL | Duration for navigation cache updates | 1 minute |
| CACHE_UPDATE_INTERVAL | Duration for homepage cache updation | 10 seconds |
| CENSUS_TOPIC_ID | Root census id (for getting census topics) | 4445 |
| DATASET_FINDER_ENABLED | Displays link to dataset finder | false |
| DEBUG | | |
| ENABLE_CENSUS_TOPIC_SUBSECTION | Displays topics subsection | false |
| ENABLE_CUSTOM_DATASET | Displays link to custom dataset builder | false |
| ENABLE_FEEDBACK_API | Enable the feedback API for use in the feedback form (as opposed to the controller) | false |
| ENABLE_GET_DATA_CARD | Displays Get Data Card | false |
| ENABLE_NEW_NAVBAR | Enables Topic API driven Nav bar | false |
| FEEDBACK_API_URL | | |
| GRACEFUL_SHUTDOWN_TIMEOUT | Time to wait during graceful shutdown | 5 seconds |
| HEALTHCHECK_CRITICAL_TIMEOUT | Amount of time to pass since last healthy health check to be deemed a critical failure | 90 seconds |
| HEALTHCHECK_INTERVAL | Interval between health checks | 30 seconds |
| OTEL_BATCH_TIMEOUT | 5s | Interval between pushes to OT Collector |
| OTEL_EXPORTER_OTLP_ENDPOINT | http://localhost:4317 | URL for OpenTelemetry endpoint |
| OTEL_SERVICE_NAME | "dp-frontend-homepage-controller" | Service name to report to telemetry tools |
| OTEL_ENABLED | false | Feature flag to enable OpenTelemetry |
| IS_PUBLISHING_MODE | Mode in which service is running | false |
| PATTERN_LIBRARY_ASSETS_PATH | | |
| SERVICE_AUTH_TOKEN | | |
| SIXTEENS_VERSION | Homepage still uses a Sixteens version for styling | |
| SITE_DOMAIN | | localhost |
| SUPPORTED_LANGUAGES | Languages which are supported separated by comma | en,cy |
| Config | Description | Default |
|-------------------------------------|----------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
| API_ROUTER_URL | The URL of the [dp-api-router](https://github.com/ONSdigital/dp-api-router) | [http://localhost:23200/v1](http://localhost:23200/v1) |
| BIND_ADDR | The Port to run on | :24400 |
| CACHE_CENSUS_TOPICS_UPDATE_INTERVAL | Duration for census topic cache updates | 1 minute |
| CACHE_NAVIGATION_UPDATE_INTERVAL | Duration for navigation cache updates | 1 minute |
| CACHE_UPDATE_INTERVAL | Duration for homepage cache updation | 10 seconds |
| CENSUS_TOPIC_ID | Root census id (for getting census topics) | 4445 |
| DATASET_FINDER_ENABLED | Displays link to dataset finder | false |
| DEBUG | false | Enable debug |
| ENABLE_CENSUS_TOPIC_SUBSECTION | Displays topics subsection | false |
| ENABLE_CUSTOM_DATASET | Displays link to custom dataset builder | false |
| ENABLE_FEEDBACK_API | Enable the feedback API for use in the feedback form (as opposed to the controller) | false |
| ENABLE_GET_DATA_CARD | Displays Get Data Card | false |
| ENABLE_NEW_NAVBAR | Enables Topic API driven Nav bar | false |
| FEEDBACK_API_URL | [http://localhost:23200/v1/feedback](http://localhost:23200/v1/feedback) | The public `dp-api-router` address for feedback, not the internal one |
| GRACEFUL_SHUTDOWN_TIMEOUT | Time to wait during graceful shutdown | 5 seconds |
| HEALTHCHECK_CRITICAL_TIMEOUT | Amount of time to pass since last healthy health check to be deemed a critical failure | 90 seconds |
| HEALTHCHECK_INTERVAL | Interval between health checks | 30 seconds |
| OTEL_BATCH_TIMEOUT | 5s | Interval between pushes to OT Collector |
| OTEL_EXPORTER_OTLP_ENDPOINT | [http://localhost:4317](http://localhost:4317) | URL for OpenTelemetry endpoint |
| OTEL_SERVICE_NAME | "dp-frontend-homepage-controller" | Service name to report to telemetry tools |
| OTEL_ENABLED | false | Feature flag to enable OpenTelemetry |
| IS_PUBLISHING_MODE | Mode in which service is running | false |
| PATTERN_LIBRARY_ASSETS_PATH | | |
| SERVICE_AUTH_TOKEN | | |
| SIXTEENS_VERSION | Homepage still uses a Sixteens version for styling | |
| SITE_DOMAIN | | localhost |
| SUPPORTED_LANGUAGES | Languages which are supported separated by comma | en,cy |

### Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for details.

### License

Copyright © 2021, Office for National Statistics (https://www.ons.gov.uk)
Copyright © 2021, Office for National Statistics [https://www.ons.gov.uk](https://www.ons.gov.uk)

Released under MIT license, see [LICENSE](LICENSE.md) for details.
4 changes: 2 additions & 2 deletions config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func get() (*Config, error) {
ServiceAuthToken: "",
SiteDomain: "localhost",
SupportedLanguages: []string{"en", "cy"},
SixteensVersion: "976e611",
SixteensVersion: "fa4e02c",
}

err := envconfig.Process("", cfg)
Expand All @@ -91,7 +91,7 @@ func get() (*Config, error) {
if cfg.Debug {
cfg.PatternLibraryAssetsPath = "http://localhost:9002/dist/assets"
} else {
cfg.PatternLibraryAssetsPath = "//cdn.ons.gov.uk/dp-design-system/e0a75c3"
cfg.PatternLibraryAssetsPath = "//cdn.ons.gov.uk/dp-design-system/2c5185a"
}

return cfg, nil
Expand Down
2 changes: 1 addition & 1 deletion config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func TestSpec(t *testing.T) {
So(cfg.HealthCheckCriticalTimeout, ShouldEqual, 90*time.Second)
So(cfg.HealthCheckInterval, ShouldEqual, 30*time.Second)
So(cfg.IsPublishingMode, ShouldEqual, false)
So(cfg.PatternLibraryAssetsPath, ShouldEqual, "//cdn.ons.gov.uk/dp-design-system/e0a75c3")
So(cfg.PatternLibraryAssetsPath, ShouldEqual, "//cdn.ons.gov.uk/dp-design-system/2c5185a")
So(cfg.SiteDomain, ShouldEqual, "localhost")
So(cfg.SupportedLanguages, ShouldResemble, []string{"en", "cy"})
})
Expand Down