yikart/AiToEarnNew scan
80/ 100 · B

Popular and well-maintained. A little polish away from elite status.

Let's use AI to Earn!

TypeScript19,834 starsMITupdated 27d ago
DocumentationREADME, setup, examples, license
90
EngineeringTests, CI, linting, lockfiles
71
Project healthDescription, activity, stars, deps
86

What to fix first

The highest-impact improvements for this repo.

  1. 1
    CI/CD
    EngineeringWarning

    Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.

  2. 2
    CI/CD
    EngineeringInfo

    Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.

  3. 3
    CI/CD
    EngineeringInfo

    Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.

Detailed breakdown

Documentation

90
  • README80
    • README is present.
    • README is well structured with multiple sections.
    • No screenshots or images in the README (−20 pts).Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    • README has code examples.
    • README links to a live demo or deployed app.
    • README includes status badges.
  • Install and run instructions100
    • README documents how to install the project.
    • README documents how to run the project.
    • .env.example is present. Contributors can see exactly which env vars to set.
  • License100
    • Licensed under MIT.
  • Contributing guide82
    • Contributing guide is detailed and thorough.
    • Contributing guide includes setup/install instructions.
    • Contributing guide lacks a code style section (−8 pts).Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    • 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 includes code examples.
    • Optional: add a Code of Conduct (+5 pts).A CODE_OF_CONDUCT.md signals that your project is welcoming. GitHub has a template you can add in one click.

Engineering

71
  • Tests60
    • Test files detected (project/aitoearn-backend/apps/aitoearn-ai/src/core/agent/mcp/mcp.utils.spec.ts).
  • CI/CD72

    Not applicable?

    • CI is configured (.github/workflows/backen-check.yml).
    • The CI workflow does not appear to run any tests (−28 pts).Add a step like `run: npm test`, `run: pytest`, or `run: tox` to your workflow file.
    • CI runs on pull requests, not just on pushes to main.
    • CI workflow runs a lint or format check.
    • Optional: add type checking to CI.Add `tsc --noEmit`, `mypy`, or `cargo check` to catch type errors before they merge.
    • Optional: report test coverage in CI.Upload coverage to Codecov, Coveralls, or report it with `--coverage` flags.
    • CI caches dependencies for faster runs.
    • CI tests across multiple environments or versions.
    • CI includes a build step.
  • Linting and formatting60
    • Linter or formatter configured (project/aitoearn-backend/.editorconfig).
  • Reproducibility80
    • Lockfile present (project/aitoearn-backend/pnpm-lock.yaml). Installs are reproducible.
    • Environment pinned via docker-compose.yml.
    • 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.
    • Security policy present.

Project health

86
  • Dependency manifest100
    • Dependency manifest found (project/aitoearn-backend/apps/aitoearn-ai/package.json).
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: TypeScript.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 19,834 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (project/aitoearn-electron/.env) (−40 pts).Remove them and add to .gitignore.
Repository files18 root entries
  • .claude
  • .github
    Good: CI is configured (.github/workflows/backen-check.yml).
    Good: Issue or PR templates present.
  • demo
  • nginx
  • presentation
  • project
    Good: Test files detected (project/aitoearn-backend/apps/aitoearn-ai/src/core/agent/mcp/mcp.utils.spec.ts).
    Good: Linter or formatter configured (project/aitoearn-backend/.editorconfig).
    Good: Lockfile present (project/aitoearn-backend/pnpm-lock.yaml). Installs are reproducible.
    Good: Security policy present.
    Good: Dependency manifest found (project/aitoearn-backend/apps/aitoearn-ai/package.json).
    Warning: Build artifacts or local files may be committed (project/aitoearn-electron/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • scripts
  • .gitignore
    Good: .gitignore present.
  • AGENTS.md
  • CONTRIBUTING_CN.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Info: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them (e.g. npm run lint, ruff check .).
    Info: 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.
    Good: Contributing guide includes code examples.
  • DOCKER_DEPLOYMENT_CN.md
  • DOCKER_DEPLOYMENT_EN.md
  • docker-compose.yml
    Good: Environment pinned via docker-compose.yml.
  • LICENSE.txt
    Good: Licensed under MIT.
  • README_EN.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Warning: 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.
  • README_JA.md
  • README.md