dp-frontend-release-calendar

command module

v1.8.0 Latest Latest Go to latest Published: Mar 5, 2024 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Provides server side rendering of the Release Calendar and Release pages.

A Release Calender page is constructed from metadata drawn from the Search API. See search service architecture docs here

A Release page is constructed from the data drawn from the Release API.

Run make help to see full list of make targets.

Run the Digital Publishing Design System (dp-design-system) in a separate shell with ./run.sh
Run make debug
In your browser, visit one of:
- http://localhost:27700/releasecalendar
- http://localhost:27700/releases/{topic} where {topic} exists in zebedee/master/releases/
For document data underlying each page, visit one of:
- http://localhost:27700/releasecalendar/data
- http://localhost:27700/releases/{topic}/data

Environment variable	Default	Description
API_ROUTER_URL	http://localhost:23200/v1	The URL of the dp-api-router
BABBAGE_MAXAGE_KEY	""	The key required to get the max age value from babbage
BABBAGE_URL	http://localhost:8080	The URL of babbage
BIND_ADDR	:27700	The host and port to bind to
DEBUG	false	Enable debug mode
DEFAULT_LIMIT	10	The default size of (number of search results on) a page
DEFAULT_MAXIMUM_LIMIT	100	The default maximum size of (number of search results on) a page
DEFAULT_MAXIMUM_SEARCH_RESULTS	1000	The default maximum number of search results that will be paged
DEFAULT_SORT	"release_date_desc"	The default sort order of search results
GRACEFUL_SHUTDOWN_TIMEOUT	5s	The graceful shutdown timeout in seconds (`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)
HEALTHCHECK_INTERVAL	30s	Time between self-healthchecks (`time.Duration` format)
PATTERN_LIBRARY_ASSETS_PATH	""	Pattern library location
ROUTING_PREFIX	""	Any routing prefix for the service
SITE_DOMAIN	localhost
SUPPORTED_LANGUAGES	[]string{"en", "cy"}	Supported languages

See CONTRIBUTING for details.

Released under MIT license, see LICENSE for details.

There is no documentation for this package.

Path	Synopsis
assets 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-debug 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-debug and generate-prod tasks in the Makefile
config
handlers Package handlers is a generated GoMock package.	Package handlers is a generated GoMock package.
mapper
mocks
model
queryparams
routes
service
mocks