86/ 100 · B

A top-tier open source project. Docs, tests, and CI are all in excellent shape.

Build fast web applications with Rust.

Rust20,904 starsMITupdated 3d ago
DocumentationREADME, setup, examples, license
97
EngineeringTests, CI, linting, lockfiles
80
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 a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.

  3. 3
    CI/CD
    EngineeringInfo

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

Detailed breakdown

Documentation

97
  • 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 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 guide78
    • Contributing guide is detailed and thorough.
    • Contributing guide lacks a setup section (−12 pts).Show new contributors how to get a local dev environment running.
    • Contributing guide describes code style expectations.
    • 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.
    • Code of conduct present.

Engineering

80
  • Tests90
    • Test files detected (any_spawner/tests).
    • Rust workspace with test files detected. Run with `cargo test --workspace`.
  • CI/CD57

    Not applicable?

    • CI is configured (.github/workflows/ci.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 does not appear to run a linter (−15 pts).Add a lint step (e.g. `npm run lint`, `ruff check .`, `cargo clippy`) to catch style issues automatically.
    • 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.
  • Linting and formatting60
    • Linter or formatter configured (rustfmt.toml).
  • Reproducibility100
    • Lockfile present (Cargo.lock). Installs are reproducible.
    • Environment pinned via examples/hackernews_islands_axum/Dockerfile.
    • Dependabot covers 2 ecosystems (github-actions, cargo). Dependencies stay current.
  • Issue and PR templates100
    • Issue or PR templates present.
    • Security policy present.

Project health

86
  • Dependency manifest100
    • Dependency manifest found (Cargo.toml).
    • Cargo.toml is a workspace manifest for a multi-crate Rust project.
  • Repository metadata70
    • Repository has a description.
    • Primary language detected: Rust.
  • Activity100
    • Actively maintained (pushed within the last month).
    • 20,904 stars.
  • Housekeeping60
    • .gitignore present.
    • Build artifacts or local files may be committed (examples/axum_js_ssr/node_modules/@highlightjs) (−40 pts).Remove them and add to .gitignore.
Repository files47 root entries
  • .config
  • .github
    Good: CI is configured (.github/workflows/ci.yml).
    Good: Dependabot covers 2 ecosystems (github-actions, cargo). Dependencies stay current.
    Good: Issue or PR templates present.
  • any_error
  • any_spawner
    Good: Test files detected (any_spawner/tests).
  • benchmarks
  • cargo-make
  • const_str_slice_concat
  • docs
  • either_of
  • examples
    Good: Environment pinned via examples/hackernews_islands_axum/Dockerfile.
    Warning: Build artifacts or local files may be committed (examples/axum_js_ssr/node_modules/@highlightjs) (−40 pts).Fix: Remove them and add to .gitignore.
  • hydration_context
  • integrations
  • leptos
  • leptos_config
  • leptos_dom
  • leptos_hot_reload
  • leptos_macro
  • leptos_server
  • logos
  • meta
  • next_tuple
  • oco
  • or_poisoned
  • projects
  • reactive_graph
  • reactive_stores
  • reactive_stores_macro
  • router
  • router_macro
  • scripts
  • server_fn
  • server_fn_macro
  • tachys
  • .gitignore
    Good: .gitignore present.
  • ARCHITECTURE.md
  • Cargo.lock
    Good: Lockfile present (Cargo.lock). Installs are reproducible.
  • Cargo.toml
    Good: Dependency manifest found (Cargo.toml).
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Info: Contributing guide lacks a setup section (−12 pts).Fix: Show new contributors how to get a local dev environment running.
    Good: Contributing guide describes code style expectations.
    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.
    Info: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • flake.lock
  • flake.nix
  • LICENSE
    Good: Licensed under MIT.
  • Makefile.toml
  • 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.
  • rustfmt.toml
    Good: Linter or formatter configured (rustfmt.toml).
  • SECURITY.md
    Good: Security policy present.
  • TODO.md