Package Health Score

76 / 100

security
No known security issues
popularity
Limited
maintenance
Healthy
community
Sustainable

Explore Similar Packages

Security

No known security issues

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
10.7.1	\|	12/2024	Popular	0 C 0 H 0 M 0 L	1 H 0 M 0 L
10.6.3	\|	10/2024		0 C 0 H 0 M 0 L	1 H 0 M 0 L
9.3.0	\|	07/2022		0 C 0 H 0 M 0 L	1 H 0 M 0 L
8.3.1	\|	10/2021		0 C 0 H 0 M 0 L	1 H 0 M 0 L
8.2.2	\|	08/2021		0 C 0 H 0 M 0 L	1 H 0 M 0 L

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

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

Limited

Weekly Downloads (84)

GitHub Stars: 40
Forks: 16
Contributors: 30

Direct Usage Popularity

The npm package chessgroundx receives a total of 84 downloads a week. As such, we scored chessgroundx popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package chessgroundx, we found that it has been starred 40 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: No
Code of Conduct: No
Contributors: 30
Funding: Yes

With more than 10 contributors for the chessgroundx 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 chessgroundx is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 19 days ago
Last Commit: 19 days ago

Further analysis of the maintenance status of chessgroundx based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that chessgroundx demonstrates a positive version release cadence with at least one new version released in the past 3 months.

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.

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: 6 years
Dependencies: 0 Direct
Versions: 103
Install Size: 527 kB
Dist-tags: 1
# of Files: 94
Maintainers: 2
TS Typings: Yes

chessgroundx 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

Chessgroundx

Chessground Xiangqi and Shogi Chessground in 2D and 3D

Chessground is a free/libre open source chess UI developed for lichess.org. It targets modern browsers, as well as mobile development using Cordova.

License

Chessground is distributed under the GPL-3.0 license (or any later version, at your option). When you use Chessground for your website, your combined work may be distributed only under the GPL. You must release your source code to the users of your website.

Please read more about GPL for JavaScript on greendrake.info.

Demos

Features

Chessground is designed to fulfill all lichess.org web and mobile apps needs, so it is pretty featureful.

Well typed with TypeScript
Fast. Uses a custom DOM diff algorithm to reduce DOM writes to the absolute minimum.
Small footprint: 10K gzipped (31K unzipped). No dependencies.
SVG drawing of circles, arrows, and custom user shapes on the board
Arrows snap to valid moves. Freehand arrows can be drawn by dragging the mouse off the board and back while drawing an arrow.
Entirely configurable and reconfigurable at any time
Styling with CSS only: board and pieces can be changed by simply switching a class
Fluid layout: board can be resized at any time
Support for 3D pieces and boards
Full mobile support (touchstart, touchmove, touchend)
Move pieces by click
Move pieces by drag & drop
- Minimum distance before drag
- Centralisation of the piece under the cursor
- Piece ghost element
- Drop off revert or trash
Premove by click or drag
Drag new pieces onto the board (editor, Crazyhouse)
Animation of pieces: moving and fading away
Display last move, check, move destinations, and premove destinations (hover effects possible)
Import and export positions in FEN notation
User callbacks
No chess logic inside: can be used for chess variants

Installation

npm install --save chessgroundx

Usage

import { Chessground } from 'chessgroundx';

const config = {};
const ground = Chessground(document.body, config);

Wrappers

React: react-chess/chessground, ruilisi/react-chessground
Vue.js: vitogit/vue-chessboard
Angular: topce/ngx-chessground
Svelte: gtm-nayan/svelte-use-chessground

More? Please make a pull request to include it here.

Documentation

Development

Install build dependencies:

yarn install

To build the node module:

yarn run compile -- --watch

To build the standalone:

yarn run dist -- --watch

chessgroundx development dependencies

@rollup/plugin-typescript @typescript-eslint/eslint-plugin @typescript-eslint/parser chai eslint jsdom jsdom-global mocha prettier rollup rollup-plugin-terser tslib typescript

FAQs

What is chessgroundx?

Extended lichess.org Chess UI. Visit Snyk Advisor to see a full health score report for chessgroundx, including popularity, security, maintenance & community analysis.

Is chessgroundx popular?

The npm package chessgroundx receives a total of 84 weekly downloads. As such, chessgroundx popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is chessgroundx well maintained?

We found that chessgroundx demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is chessgroundx safe to use?

The npm package chessgroundx was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 22:54 (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

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (84)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Chessgroundx

License

Demos

Features

Installation

Usage

Wrappers

Documentation

Development

chessgroundx development dependencies

FAQs

What is chessgroundx?

Is chessgroundx popular?

Is chessgroundx well maintained?

Is chessgroundx safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues