typesense/typesense

0

/ 100

Documentation85
Engineering78
Health100
C++26,054GPL-3.05d ago
Grade a repo

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

Open Source alternative to Algolia + Pinecone and an Easier-to-Use alternative to ElasticSearch ⚡ 🔍 ✨ Fast, typo tolerant, in-memory fuzzy Search Engine for building delightful search experiences

Documentation

85

Contributing guide5pt53

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.

README12pt80

README is present.

Install and run instructions9pt100

README documents how to install the project.

License6pt100

Licensed under GPL-3.0.

Engineering

78

CI/CD14pt57

CI is configured (.github/workflows/tests.yml).

Tests18pt80

Test files detected (api_tests/tests).

Reproducibility6pt80

Lockfile present (api_tests/bun.lock). Installs are reproducible.

Linting and formatting5pt100

Linter or formatter configured (benchmark/.prettierrc).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

100

Dependency manifest6pt100

Dependency manifest found (api_tests/package.json).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository files32 root entries
  • .github
    Good: CI is configured (.github/workflows/tests.yml).
    Good: Issue or PR templates present.
  • api_tests
    Good: Test files detected (api_tests/tests).
    Good: Lockfile present (api_tests/bun.lock). Installs are reproducible.
    Good: Dependency manifest found (api_tests/package.json).
  • assets
  • bazel
  • benchmark
    Good: Linter or formatter configured (benchmark/.prettierrc).
    Good: Environment pinned via benchmark/Dockerfile.
  • cmake
  • debian-pkg
  • docker
  • include
  • src
  • test
  • tests
  • .bazelrc
  • .bazelversion
  • .gitignore
    Good: .gitignore present.
  • BUILD
  • build.sh
  • ci_build_v2.sh
  • ci_build.sh
  • CMakeLists.txt
  • CONTRIBUTING.md
    Issue: 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.
    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.
  • DESIGN.md
  • docker-build.sh
  • LICENSE.txt
    Good: Licensed under GPL-3.0.
  • publish_release.sh
  • 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.
    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.
  • recipes.jsonl
  • SECURITY.md
    Good: Security policy present.
  • SHOWCASE.md
  • TODO.md
  • tsan.supp
  • WORKSPACE