Polished work that hasn't found its audience yet.
基于 Holepunch 技术栈(底层核心为 hypercore 和 hyperswarm)
Documentation
88
README is present.
README documents how to install the project.
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.
Licensed under MIT.
Engineering
96
Lockfile present (package-lock.json). Installs are reproducible.
Test files detected (electron/updateChecker.test.js).
CI is configured (.github/workflows/ci.yml).
Linter or formatter configured (.prettierrc).
Issue or PR templates present.
Project health
95
Dependency manifest found (package.json).
Repository has a description.
Actively maintained (pushed within the last month).
.gitignore present.
Repository files23 root entries
- .githubGood: CI is configured (.github/workflows/ci.yml).Good: Issue or PR templates present.
- docsIssue: 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.Good: Contributing guide includes setup/install instructions.Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.Good: Contributing guide explains how to run tests.Good: Contributing guide describes the PR/review workflow.Good: Contributing guide includes code examples.Good: Code of conduct present.
- electronGood: Test files detected (electron/updateChecker.test.js).
- public
- scripts
- server
- src
- .gitattributes
- .gitignoreGood: .gitignore present.
- .prettierignore
- .prettierrcGood: Linter or formatter configured (.prettierrc).
- AGENTS.md
- eslint.config.js
- global.d.ts
- LICENSEGood: Licensed under MIT.
- logo.svg
- package-lock.jsonGood: Lockfile present (package-lock.json). Installs are reproducible.
- package.jsonGood: Dependency manifest found (package.json).
- README.mdGood: README is present.Good: README is well structured with multiple sections.Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.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.
- tsconfig.json
- tsconfig.strict-router.json
- tsconfig.typecheck.json
- vite.config.ts