Categorygithub.com/ONSdigital/dp-developer-site
modulepackage
1.1.0
Repository: https://github.com/onsdigital/dp-developer-site.git
Documentation: pkg.go.dev

# README

dp-developer-site

A Go application that generates the HTML pages for the developer hub for ons.gov.uk.

Available at developer.ons.gov.uk.

Getting started

To run this app you'll need certain versions installed:

Languageversion
Go>= 1.21.7
Node= 20.1.3
Python>= 3.9.2

These versions are what the pipeline will build with.

You can use nvm use to set your Node version to the current compatible one.

You'll also need github.com/fogleman/serve@latest which you can install using:

    make install-prereqs

Development

The templates that make up the developer hub are available in /templates.

Static pages, such as the introduction are in /static.

The most common use case will be to update files and watch them change on the local site:

to watch the files for changes and host them run:

make watch-serve

or, with a custom port:

make watch-serve PORT=8000

Other notable commands are as follows

To watch and automatically rebuild the site on any changes to any .go, .md or .tmpl file run:

make watch

To only serve the built assets (on default port of 23600) run:

make serve

...which has an optional PORT environment variable, for example:

make server PORT=8000

Configuration

Environment variableDefaultDescription
PORT23600The port to serve the files on

Contributing

See CONTRIBUTING for details.

License

Copyright © 2017-2024, Office for National Statistics (https://www.ons.gov.uk)

Released under MIT license, see LICENSE for details.

# Packages

No description provided by the author
No description provided by the author

# Variables

No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author