Skip to content
This repository has been archived by the owner on Jun 25, 2024. It is now read-only.

tim-s-ccs/ts-ccs-frontend

Repository files navigation

CCS Frontend · Build Status JavaScript Style Guide

CCS Frontend contains the code you need to start building a user interface for CCS platforms and services.

This is based off of GOV.UK Frontend which was created and is maintained by a team at the Government Digital Service.

Because of this, CCS Frontend can be used in an identical way to GOV.UK Frontend.

See live examples of CCS Frontend in the CCS Frontend website.

As part of future work, there will be a place where you can view live examples and guidance on when to use CCS Frontend as part of your service.

STATUS: BUILD AND DEVELOPMENT

At the moment this project is still in the build and development phase.

As it is still not decided if CCS wants to take on this project, it is being hosted on the personal accounts of tim-s-ccs.

That is why the package is called ts-ccs-frontend on NPM.

This will all be updated, with real package name confirmed, before the first major release.

Contact the team

CCS Frontend is maintained by a team at the Crown Commercial Service.

If you want to know more about CCS Frontend, please email Tim South

Quick start

Please note that this package is designed to be used in the same way as GOV.UK Frontend so if these documents are not sufficient, please try the documentation for GOV.UK Frontend.

There are 2 ways to start using CCS Frontend in your app.

Once installed, you will be able to use the code from the examples in the CCS Frontend website in your service.

1. Install with npm (recommended)

We recommend installing CCS Frontend using node package manager (npm).

2. Install using compiled files

You can also install CCS Frontend by copying our CSS, JavaScript and asset files into your project.

Browser and assistive technology support

CCS Frontend supports:

Accessibility

The CCS Development team works hard to ensure that CCS Frontend is accessible.

Using CCS Frontend along with GOV.UK Frontend will help your service meet level AA of WCAG 2.1. But you must still check that your service meets accessibility requirements, especially if you extend or modify components.

You should also use:

An accessibility statement for the CCS Design System will be added in the future.

Accessibility warnings

If you get a warning from a linter or accessibility checker, check the list of issues you should not need to fix from GOV.UK Frontend.

Getting updates

To be notified when there’s a new release, you can:

Find out how to update with npm.

Security

CCS is an advocate of responsible vulnerability disclosure. If you’ve found a vulnerability, we would like to know so we can fix it.

If you have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner.

Please follow the CCS vulnerability reporting steps, giving details of any issue you find. Appropriate credit will be given to those reporting confirmed issues.

Licence

Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation. The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.

Contributing

To learn how to help us build CCS Frontend, see our contribution guidelines.

The ts-ccs-frontend repository is public and we welcome contributions from anyone.

However, please note this a small project compared to GOV.UK Frontend and is only concerned with assets relating to CCS.

We're unable to monitor activity on this repository outside of our office hours (10am to 4pm, UK time). To get a faster response at other times, you can report abuse or spam to GitHub.

Credits 🏆

This project was created from GOV.UK Frontend so a lot of the credit needs to go to the team at Government Digital Services. Beyond adding the CCS stylings, nearly all the code comes from that original project.

So a big Thank you to the team at GDS because, without your hard work on GOV.UK Frontend, CCS Frontend would be a much lesser offering.