wmn-design-system

v2.4.0

A library of typography, visual styles and user interface components which are documented for Transport for West Midlands. For more information about how to use this package see README

Latest version published 3 years ago

License: Unknown

NPM

GitHub

Package Health Score

39 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Security

Security review needed

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

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.3.1	\|	12/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.4.0	\|	12/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.8.0	\|	07/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.3	\|	06/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.0	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Unknown

Unable to detect license

We couldn’t find an appropriate license for this project. It is highly advised to make sure the project license is compatible with your business needs before including it as a dependency, to keep yourself protected from infringement suits or loss of your own code.

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (2,446)

GitHub Stars: 5
Forks: 3
Contributors: 20

Direct Usage Popularity

The npm package wmn-design-system receives a total of 2,446 downloads a week. As such, we scored wmn-design-system popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package wmn-design-system, we found that it has been starred 5 times.

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

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the wmn-design-system repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like wmn-design-system is missing a Code of Conduct.

How about a good first contribution to this project? It seems that wmn-design-system is missing a LICENSE file.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 11
Open PR: 17
Last Release: 3 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of wmn-design-system 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 wmn-design-system 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.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 8 Direct
Versions: 20
Install Size: 22.5 MB
Dist-tags: 1
# of Files: 430
Maintainers: 1
TS Typings: No

wmn-design-system 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.

Readme

1. TfWM Design System

1.1. Table of contents

1. TfWM Design System

1.2. Overview

Welcome to the Transport for West Midlands Design System.

The TfWM design system is ran at the designated url on startup (usually https://localhost:3000) and is the primary means of viewing your work - it will live update as you make changes.

Tailored for building Transport for West Midlands apps and websites: Using the TfWM Design System markup and CSS framework results in UIs that reflect the Transport for West Midlands look and feel.
Continuously updated: As long as you're using the latest version of the TfWM Design System, your pages are always up to date with Transport for West Midlands UI changes.

Transport for West Midlands design system example

1.3. Quick start

You'll need Git and Node.js installed to get this project running.

Clone the project with git clone https://github.com/wmcadigital/wmn-design-system.git
Run npm install in the root folder.
Run npm start to launch the dev environment with hot reloading.
Visit https://localhost:3000

Having trouble getting these steps to work on your machine? Follow the troubleshooting guide.

1.4. Tasks

For more in-depth information on what each task does, see tasks guide.

1.4.1. Starting web server

Start the TfWM Design System web server.

npm start

1.4.2. Linting

Lint the code base for syntax and stylistic errors.

See Linting for more details.

# Lint indentation, Sass, JavaScript files, html
npm run lint:all

# Lint languages independently
npm run lint:styles
npm run lint:templates
npm run lint:scripts

1.4.3. Compilation

Build the design system for various environments

See Building for more details.

# Build Sass, JavaScript, HTML files
npm run build:all

# Build languages/assets independently
npm run build:styles
npm run build:templates
npm run build:scripts
npm run build:images
npm run build:sprites
npm run build:config

1.4.4. Clean up

Delete all built languages/assets including temporary build and local files.

npm run clean

1.5. Troubleshooting

See the troubleshooting guide.

1.6. Contributing to the code base

See the contributing guide.

1.7. Got feedback?

Please open a new Github Issue.

wmn-design-system dependencies

@sentry/browser array-flat-polyfill axios findandreplacedomtext gulp-sass iframe-resizer path tfwm-travel-updates-widget

FAQs

What is wmn-design-system?

A library of typography, visual styles and user interface components which are documented for Transport for West Midlan... Visit Snyk Advisor to see a full health score report for wmn-design-system, including popularity, security, maintenance & community analysis.

Is wmn-design-system popular?

The npm package wmn-design-system receives a total of 2,446 weekly downloads. As such, wmn-design-system popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is wmn-design-system well maintained?

We found indications that wmn-design-system is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is wmn-design-system safe to use?

While scanning the latest version of wmn-design-system, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 30 September-2024, at 22:28 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP