abpframework/abp

0

/ 100

Documentation71
Engineering78
Health94
C#14,316LGPL-3.05d ago
Grade a repo

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

Open-source web application framework for ASP.NET Core! Offers an opinionated architecture to build enterprise software solutions with best practices on top of the .NET. Provides the fundamental infrastructure, cross-cutting-concern implementations, startup templates, application modules, UI themes, tooling and documentation.

Documentation

71

Install and run instructions9pt45

README documents how to install the project.

Contributing guide5pt52

CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +12 pts.

→ Add setup instructions, code style notes, and how to run tests.

README12pt85

README is present.

License6pt100

Licensed under LGPL-3.0.

Engineering

78

CI/CD14pt57

CI is configured (.github/workflows/build-and-test.yml).

Tests18pt80

Test files detected (.github/scripts/test_update_dependency_changes.py).

Reproducibility6pt80

Lockfile present (modules/basic-theme/test/Volo.Abp.AspNetCore.Mvc.UI.Bootstrap.Demo/yarn.lock). Installs are reproducible.

Linting and formatting5pt100

.NET formatting configured (.editorconfig).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

94

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (.github/scripts/CheckDocsSyntax/CheckDocsSyntax.csproj).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Repository files41 root entries
  • .agents
  • .claude
  • .github
    Good: Test files detected (.github/scripts/test_update_dependency_changes.py).
    Good: CI is configured (.github/workflows/build-and-test.yml).
    Good: Issue or PR templates present.
    Good: Dependency manifest found (.github/scripts/CheckDocsSyntax/CheckDocsSyntax.csproj).
  • abp_io
  • ai-rules
  • apiSpec
  • build
  • deploy
  • docs
  • framework
  • modules
    Good: Lockfile present (modules/basic-theme/test/Volo.Abp.AspNetCore.Mvc.UI.Bootstrap.Demo/yarn.lock). Installs are reproducible.
    Good: Environment pinned via modules/basic-theme/test/Volo.Abp.AspNetCore.Mvc.UI.Bootstrap.Demo/Dockerfile.
  • npm
    Issue: Build artifacts or local files may be committed (npm/ng-packs/.env) (−40 pts).Fix: Remove them and add to .gitignore.
  • nupkg
  • schemas
  • source-code
  • studio
  • templates
  • test
  • tools
  • .cursorrules
  • .dockerignore
  • .editorconfig
    Good: .NET formatting configured (.editorconfig).
  • .gitattributes
  • .gitignore
    Good: .gitignore present.
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • codecov.yml
  • common.DotSettings
  • common.props
  • common.test.props
  • configureawait.props
  • CONTRIBUTING.md
    Issue: CONTRIBUTING guide is very brief (−12 pts for depth). 150+ words earns +6 pts; 400+ earns +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).
    Issue: Contributing guide lacks a PR workflow section (−8 pts).Fix: Explain how to fork, branch, and open a pull request so contributors know what to expect.
    Issue: Contributing guide has no code examples (−5 pts).Fix: Add code blocks showing example commands for setup, running tests, and submitting a PR.
  • delete-bin-obj.ps1
  • Directory.Build.props
  • Directory.Packages.props
  • global.json
  • latest-versions.json
  • LICENSE.md
    Good: Licensed under LGPL-3.0.
  • NuGet.Config
  • NuGet.md
  • README.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.
  • SECURITY.md
    Good: Security policy present.