79
/ 100
Good shape overall. A few tweaks would push it into the top tier.
Running electerm as web app
Top fixes
Highest-impact changes first, ranked by point weight
- 1Tests18pt
Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.
- 2CI/CD14pt
If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
- 3Install and run instructions9pt
Add a .env.example listing all required environment variables so contributors know what to set up.
- 4Reproducibility6pt
Add a Dockerfile, .nvmrc, or .python-version to pin the runtime version and make the environment reproducible.
Working through the fixes? Let every push regrade itself.
The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.
Scorecard
Every check, grouped by category and sorted worst-first
Documentation
93
CONTRIBUTING guide found.
README documents how to install the project.
README is present.
Licensed under MIT.
Engineering
62
No CI configuration detected in this repository.
→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.
A test script is configured in package.json.
Lockfile present (package-lock.json). Installs are reproducible.
Linter or formatter configured (lint script in package.json).
Issue or PR templates present.
Project health
97
Dependency manifest found (package.json).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository health signals
Activity, community, and responsiveness at scan time
Activity
- 23 / 48Commits (30d / 90d)
- 29Forks
- 0Releases
Community
- 62% - FairCommunity health
- -authors own >50% of commits
- 165Watchers
Responsiveness
- 2hMedian issue response
- <1hMedian PR merge time
- 13Open issues
Repository files13 root entries
- .githubGood: CONTRIBUTING guide found.Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.Good: Dependabot configured for github-actions.Good: Issue or PR templates present.
- build
- examples
- src
- .gitignoreGood: .gitignore present.
- .sample.env
- config.sample.js
- LICENSEGood: Licensed under MIT.
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- README_cn.mdGood: 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.
- README.md
- run-electerm-web.sh
Add this badge to your README
It updates automatically each time the repo is re-graded.
[](https://www.repo-grade.com/report/electerm/electerm-web)