opensource-construction/osc-directory

0

/ 100

Documentation52
Engineering72
Health100
TypeScript28MIT1d ago
Grade a repo

Solid foundation. Invest in docs and CI to grow from here.

The AEC Open Source Directory - a curated directory of open source projects for the Architecture, Engineering, and Construction (AEC) industry.

Documentation

52

Contributing guide5pt0

No CONTRIBUTING.md found (−47 pts base + up to −53 pts more for content).

→ Add a CONTRIBUTING.md telling newcomers how to get involved. Include setup, code style, test, and PR instructions.

Install and run instructions9pt45

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt55

README is present.

License6pt100

Licensed under MIT.

Engineering

72

CI/CD14pt40

CI is configured (.github/workflows/rebuild-manual.yml).

Reproducibility6pt70

Lockfile present (backend/pnpm-lock.yaml). Installs are reproducible.

Tests18pt80

Test files detected (backend/test).

Linting and formatting5pt100

Linter or formatter configured (backend/.prettierrc).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (backend/package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 4
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 28
    Watchers

Responsiveness

  • <1h
    Median issue response
  • <1h
    Median PR merge time
  • 3
    Open issues
Repository files8 root entries
  • .github
    Good: CI is configured (.github/workflows/rebuild-manual.yml).
    Good: Issue or PR templates present.
  • backend
    Good: Test files detected (backend/test).
    Good: Linter or formatter configured (backend/.prettierrc).
    Good: Lockfile present (backend/pnpm-lock.yaml). Installs are reproducible.
    Good: Dependency manifest found (backend/package.json).
  • docs
  • frontend
  • shared
  • .gitignore
    Good: .gitignore present.
  • LICENSE
    Good: Licensed under MIT.
  • README.md
    Good: 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.
    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.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Good: README documents how to run the project.