README
¶
devpulse
Multi-tenant SaaS for GitHub project health analytics. Users sign in with GitHub OAuth, install a GitHub App on their repos, and get a hosted dashboard at devpulse.thingz.io.
The hosted instance is a reference implementation operated on a best-effort basis — free to use, no plans or pricing, no SLA.
Two binaries: devpulse-site (HTTP server + integrated admin dashboard), devpulse-import (batch worker). PostgreSQL with Row-Level Security for tenant isolation.
Development
git clone https://github.com/thingzio/devpulse.git && cd devpulse
make test # unit tests with race detector
make lint # go vet + golangci-lint + yamllint + tfsec
make qualify # test-coverage + lint + govulncheck + e2e
Documentation
| Doc | Purpose |
|---|---|
| DEVELOPMENT.md | Local setup, make targets, debugging |
| ARCHITECTURE.md | System design, data model, tenant isolation |
| ADMIN.md | Day-2 operations, monitoring, CI/CD, tenant management |
| INFRASTRUCTURE.md | GCP tiers, scaling, costs, API throughput |
| PERFORMANCE.md | Query tuning method, endpoint baselines, findings |
| BOOTSTRAP.md | One-time GCP deployment guide |
| PLANS.md | Per-account limit enforcement |
| VIEWS.md | Dashboard tabs and chart guide |
| GITLAB.md | GitLab support feasibility assessment |
Contributing
See CONTRIBUTING.md for guidelines and docs/DEVELOPMENT.md for setup.
- Fork and clone
- Create a feature branch
- Run
make qualify - Submit a pull request
License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
devpulse-import
command
|
|
|
devpulse-site
command
|
|
|
pkg
|
|
|
platformstats
Package platformstats writes daily admin-dashboard rollups to devpulse_platform_stats.
|
Package platformstats writes daily admin-dashboard rollups to devpulse_platform_stats. |
Click to show internal directories.
Click to hide internal directories.