Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gojp/goreportcard
A report card for your Go application
https://github.com/gojp/goreportcard
go golang golang-tools goreportcard report-card
Last synced: 12 days ago
JSON representation
A report card for your Go application
- Host: GitHub
- URL: https://github.com/gojp/goreportcard
- Owner: gojp
- License: apache-2.0
- Created: 2015-01-29T15:07:37.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-03T09:16:41.000Z (about 2 months ago)
- Last Synced: 2024-12-31T15:07:08.682Z (19 days ago)
- Topics: go, golang, golang-tools, goreportcard, report-card
- Language: Go
- Homepage: https://goreportcard.com
- Size: 11.7 MB
- Stars: 2,019
- Watchers: 28
- Forks: 249
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - gojp/goreportcard - A report card for your Go application (Go)
- go-awesome - **Go Report Card** - Go project quality analysis report tool (Open source library / Code Analysis)
- awesome-golang-repositories - goreportcard
README
[](https://goreportcard.com/report/gojp/goreportcard) [](https://github.com/gojp/goreportcard/blob/master/LICENSE)
# Go Report Card
A web application that generates a report on the quality of an open source Go project. It uses several measures, including `gofmt`, `go vet`, `go lint` and `gocyclo`. To get a report on your own project, try [goreportcard.com](https://goreportcard.com).
### Sponsors
Support us over on [Patreon](https://www.patreon.com/goreportcard)!
- [Cody Wood](https://www.linkedin.com/in/sprkyco/)
- Pascal Wenger
- Jonas Kwiedor
- [PhotoPrism](https://photoprism.app)
- Kia Farhang
- [Patrick DeVivo](https://twitter.com/patrickdevivo) ([MergeStat](https://github.com/mergestat/mergestat))
- [Alexis Geoffrey](https://github.com/alexisgeoffrey)
### Installation
```
git clone https://github.com/gojp/goreportcard.git
cd goreportcard
make install
```
Now run:
```
GRC_DATABASE_PATH=./db make start
```
and you should see
```
Running on :8000...
```
Navigate to `localhost:8000` and you should see the Go Report Card front page.
### Command Line Interface
There is also a CLI available for grading applications on your local machine.
Example usage:
```
git clone https://github.com/gojp/goreportcard.git
cd goreportcard
make install
go install ./cmd/goreportcard-cli
goreportcard-cli
```
```
Grade .......... A+ 99.9%
Files ................ 362
Issues ................. 2
gofmt ............... 100%
go_vet ............... 99%
gocyclo .............. 99%
golint .............. 100%
ineffassign ......... 100%
license ............. 100%
misspell ............ 100%
```
Verbose output:
```
goreportcard-cli -v
```
```
Grade .......... A+ 99.9%
Files ................ 362
Issues ................. 2
gofmt ............... 100%
go_vet ............... 99%
go_vet vendor/github.com/prometheus/client_golang/prometheus/desc.go:25
error: cannot find package "github.com/prometheus/client_model/go" in any of: (vet)
gocyclo .............. 99%
gocyclo download/download.go:22
warning: cyclomatic complexity 17 of function download() is high (> 15) (gocyclo)
golint .............. 100%
ineffassign ......... 100%
license ............. 100%
misspell ............ 100%
```
### Contributing
Go Report Card is an open source project run by volunteers, and contributions are welcome! Check out the [Issues](https://github.com/gojp/goreportcard/issues) page to see if your idea has already been mentioned. Feel free to raise an issue or submit a pull request.
### Academic Citation
If you use Go Report Card for academic purposes, please use the following citation:
```
@Misc{schaaf-smith-goreportcard,
author = {Schaaf, Herman and Smith, Shawn},
title = {Go Report Card: A report card for your Go application},
year = {2015--},
url = {https://www.goreportcard.com/},
note = {[Online; accessed ]}
}
```
### License
The code is licensed under the permissive Apache v2.0 license. [Read this](https://tldrlegal.com/license/apache-license-2.0-(apache-2.0)) for a summary.