@penx/govuk-frontend

v0.0.2

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

NPM

README

GitHub

Website

MIT

Latest version published 2 years ago

    npm install @penx/govuk-frontend

We couldn't find any similar packages Browse all packages

Package Health Score

64 / 100

Popularity
Limited
Maintenance
Inactive
Security
No known security issues
Community
Active

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (2)

Dependents: 80
GitHub Stars: 466
Forks: 205
Contributors: 50

The npm package @penx/govuk-frontend receives a total of 2 downloads a week. As such, we scored @penx/govuk-frontend popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @penx/govuk-frontend, we found that it has been starred 466 times, and that 80 other projects on the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.0.2

Indirect Vulnerabilities

0.0.2

License Risks

0.0.2

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security Policy: No

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

We found a way for you to contribute to the project! Looks like @penx/govuk-frontend is missing a security policy.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test @penx/govuk-frontend

Fix it in your project with Snyk!

Maintenance

Inactive

Commit Frequency

Open Issues: 191
Merged PR: 1.18K
Open PR: 13
Last Commit: 6 days ago

Further analysis of the maintenance status of @penx/govuk-frontend based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @penx/govuk-frontend is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 50
Funding: No
License: MIT

With more than 10 contributors for the @penx/govuk-frontend repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Package

Node.js Compatibility: >= 4.2.0

Age: 2 years
Dependencies: 0 Direct / 0 Total
Versions: 3
Install Size: 1.52 MB
Dist-tags: 1
# of Files: 244
Maintainers: 1
TS Typings: No

@penx/govuk-frontend has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

GOV.UK Frontend

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

See live examples of GOV.UK Frontend components, and guidance on when to use them in your service, in the GOV.UK Design System.

Contact the team

GOV.UK Frontend is maintained by a team at Government Digital Service. If you want to know more about GOV.UK Frontend, please email the Design System team or get in touch with them on Slack.

Quick start

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

Once installed, you will be able to use the code from the examples in the GOV.UK Design System in your service.

1. Install with npm (recommended)

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

2. Install by using compiled files

You can also download the compiled and minified assets (CSS, JavaScript) from GitHub.

Importing styles

You need to import the GOV.UK Frontend styles into the main Sass file in your project. You should place the below code before your own Sass rules (or Sass imports) if you want to override GOV.UK Frontend with your own styles.

To import add the below to your Sass file:

@import "node_modules/govuk-frontend/all";

More details on importing styles

Importing JavaScript

Some of the JavaScript included in GOV.UK Frontend improves the usability and accessibility of the components. You should make sure that you are importing and initialising Javascript in your application to ensure that all users can use it successfully.

You can include Javascript for all components either by copying the all.js from node_modules/govuk-frontend into your application or referencing the file directly:

<script src="<path-to-govuk-frontend-all-file>/all.js"></script>

Next you need to initialise the script by adding:

<script>window.GOVUKFrontend.initAll()</script>

More details on importing Javascript and advanced options

Importing assets

In order to import GOV.UK Frontend images and fonts to your project, you should configure your application to reference or copy the relevant GOV.UK Frontend assets.

More details on importing assets

Getting updates

To check whether you have the latest version of GOV.UK Frontend, run:

npm outdated govuk-frontend

To update to the latest version, run:

npm update govuk-frontend

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.

Contribution guidelines

If you want to help us build GOV.UK Frontend, view our contribution guidelines.