96/ 100 ยท A

Polished and well engineered. Punching above its star count.

๐Ÿ“Š Create interactive, animated 3d graphs. Surfaces, lines, dots and block styling out of the box.

JavaScript352 starsApache-2.0updated 1d ago

Outstanding work. A score of 96/100 puts this repo in a very small tier of truly well-engineered open source projects.

DocumentationREADME, setup, examples, license
91
EngineeringTests, CI, linting, lockfiles
98
Project healthDescription, activity, stars, deps
100

What to fix first

The highest-impact improvements for this repo.

  1. 1
    Install and run instructions
    DocumentationIssue

    Add a .env.example listing all required environment variables so contributors know what to set up.

  2. 2
    Reproducibility
    EngineeringIssue

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  3. 3
    Issue and PR templates
    EngineeringInfo

    A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Detailed breakdown

Documentation

91
  • README100
    • README is present.
    • README is well structured with multiple sections.
    • README includes screenshots or visuals. Great for first impressions.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions90
    • README documents how to install the project.
    • README documents how to run the project.
    • No .env.example found (โˆ’10 pts).Add a .env.example listing all required environment variables so contributors know what to set up.
  • License100
    • Licensed under Apache-2.0.
  • Contributing guide61
    • Contributing guide is too short for full depth credit (โˆ’6 pts). 400+ words earns the full +12 pts.Add setup instructions, code style notes, and how to run tests.
    • Contributing guide lacks a setup section (โˆ’12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide lacks a code style section (โˆ’8 pts).Describe your linting/formatting rules and how to run them.
    • Contributing guide lacks a testing section (โˆ’8 pts).Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    • Contributing guide describes the PR/review workflow.
    • Contributing guide has no code examples (โˆ’5 pts).Add code blocks showing example commands for setup, running tests, and submitting a PR.
    • Optional: add a Code of Conduct.A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

98
  • Tests100
    • Test files detected (.mocharc.json).
  • CI/CD100

    Not applicable?

    • CI is configured (.circleci/config.yml).
  • Linting and formatting100
    • Linter or formatter configured (.eslintrc.cjs).
  • Reproducibility80
    • Lockfile present (package-lock.json). Installs are reproducible.
    • Environment pinned via .mise.toml.
    • No Dependabot config (adding it earns up to +20 pts).Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Optional: add a SECURITY.md.A SECURITY.md explains how to responsibly disclose vulnerabilities. Worth adding once the project has real users.

Project health

100
  • Dependency manifest100
    • Dependency manifest found (package.json).
    • package.json has a description field.
    • package.json links back to the repository.
  • Repository metadata100
    • Repository has a description.
    • Primary language detected: JavaScript.
    • package.json metadata is complete (description, keywords, repository).
  • Activity100
    • Actively maintained (pushed within the last month).
    • 352 stars.
  • Housekeeping100
    • .gitignore present.
Repository files41 root entries
  • __snapshots__
  • .circleci
    Good: CI is configured (.circleci/config.yml).
  • .github
    Good: Issue or PR templates present.
  • .husky
  • declarations
  • docs
  • examples
  • lib
  • misc
  • scripts
  • test
  • .csslintrc
  • .eslintignore
  • .eslintrc.cjs
    Good: Linter or formatter configured (.eslintrc.cjs).
  • .gitignore
    Good: .gitignore present.
  • .mdlrc
  • .mise.toml
    Good: Environment pinned via .mise.toml.
  • .mocharc.json
    Good: Test files detected (.mocharc.json).
  • .npmignore
  • .nvmrc
  • .prettierignore
  • .releaserc.yml
  • babel.config.js
  • CODE-OF-CONDUCT.md
  • CONTRIBUTING.md
    Issue: Contributing guide is too short for full depth credit (โˆ’6 pts). 400+ words earns the full +12 pts.Fix: Add setup instructions, code style notes, and how to run tests.
    Issue: Contributing guide lacks a setup section (โˆ’12 pts).Fix: Show new contributors how to get a local dev environment running.
    Issue: Contributing guide lacks a code style section (โˆ’8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (โˆ’8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Issue: Contributing guide has no code examples (โˆ’5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • generate-examples-index.json
  • HISTORY.md
  • index.html
  • index.js
  • jsdoc.json
  • launch.json
  • LICENSE-APACHE-2.0
  • LICENSE-MIT
  • package-lock.json
    Good: Lockfile present (package-lock.json). Installs are reproducible.
  • package.json
    Good: Dependency manifest found (package.json).
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • renovate.json
  • rollup.build.js
  • rollup.config.js
  • tsconfig.json
  • tsconfig.lint.json