Single Page Platform Development Kit (PDK)

This Platform development kit includes and extends the GDS GOV.UK packages for developing citizen and business facing services as a platform.

View the PDK here: http://cjscommonplatform.github.io/govuk_single_page_pdk

What is the PDK

The PDK is a platform used to make single page applications that deliver government services. It consists of two parts, the feature rich “platform components” and the “platform templates” they contain extendable JavaScript modules and a library of styles respectively. The components and templates provide a complete solution to create business and citizen facing services that are; scalable, intuitive, accessibility compliant and provide a robust user experience. The following principles are the driving force behind the PDK; User Driven Experience, Domain Driven Design, Extendable Governance, Automated Assurance, Continuous Improvement and Openness.

Geting started

Here are some guidance notes to quickly start using the Platform Development Kit.

Prerequisite

Please install the following software.

• Git
• Node

Installation

npm install

Serve

npm start to build your client app and start a webserver

Development

npm start to allow file changes to update in realtime

Distribute

npm run build_dev to prepare a distributable bundle

Packages

Platform components - npm i @cppui/angularjs-components Platform templates - npm i @cppui/platform-template

How can developers contribute?

Currently the PDK is available for contribution as a whole project including the source code to create this page. Here are some useful folders & files for contributors; pdk_root/modules/components pdk_root/modules/content pdk_root/index.scss

Download the PDK

The latest stable version of the project source code can be viewed here: https://github.com/CJSCommonPlatform/govuk_single_page_pdk. To clone the project please run: git clone git@github.com:CJSCommonPlatform/govuk_single_page_pdk.git. The live project is available online and can be viewed here: http://cjscommonplatform.github.io/govuk_single_page_pdk/#/. Navigate into the folder entitled govuk_single_page_pdk and run npm install.

Boilerplate coming soon

The developers behind the PDK are currently creating a boilerplate to help users get projects up and running efficiently.

Angular 2 & Angular Universal docs

New documentation is currently in the progress to detail services developed using Angular 2 and Angular Universal.