Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/moethu/codenutrition

Nutrition Facts for Code
https://github.com/moethu/codenutrition

go labels legacy-code transparency

Last synced: 30 days ago
JSON representation

Nutrition Facts for Code

Host: GitHub
URL: https://github.com/moethu/codenutrition
Owner: moethu
License: mit
Created: 2020-01-21T16:41:45.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2021-08-24T13:47:55.000Z (over 3 years ago)
Last Synced: 2024-10-16T19:29:28.915Z (3 months ago)
Topics: go, labels, legacy-code, transparency
Language: Go
Homepage: http://code.grevit.net:8084
Size: 294 KB
Stars: 4
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Code Nutrition

[![codenutrition](http://code.grevit.net/badge/O%2B%2B_S%2B%2B_I%2B%2B_C_E_M_V%2B_PS%2B%2B_D%2B_)](http://code.grevit.net/facts/O%2B%2B_S%2B%2B_I%2B%2B_C_E_M_V%2B_PS%2B%2B_D%2B)

**Imagine your code and all dependencies would carry nutrition labels.**

Code Nutrition is a service for labelling code so everybody can understand what they are getting into when building upon or using your software. The survey is based on a set of questions presented by Felix von Leitner: "Nützlich-Unbedenklich Spektrum" at 36C3 (Minor adjustmenst have been made to the original text.) [learn more here](https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=1&cad=rja&uact=8&ved=2ahUKEwjE-v7ropLnAhXUwMQBHd68B9UQwqsBMAB6BAgKEAQ&url=https%3A%2F%2Fmedia.ccc.de%2Fv%2F36c3-10608-das_nutzlich-unbedenklich_spektrum&usg=AOvVaw1_05ix3-K_lRn_T9LbJRZi).

The survey itself is still under development you are welcome to discuss, contribute and improve it. Currently it consists of 9 fundamental questions regarding the state of your (legacy) code. After answering them by multiple choice the service generates an embeddable badge representing the state of your project. I highly reccommend completing the survey even if you don't want to use the badge - the questions asked can be very helpful.

[Survey](https://github.com/moethu/codenutrition/blob/master/static/spectrum.json)

Again, the intention of this repo and the survey is to get the conversation started and potentially develop a solid metric representing the state of a project.

[Start your survey now](http://code.grevit.net:8084)

## Requirements for building the service

[![Go Report Card](https://goreportcard.com/badge/github.com/moethu/codenutrition)](https://goreportcard.com/report/github.com/moethu/codenutrition)

- go 1.11.5+

### requirements (via go modules)

- github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751
- github.com/gin-gonic/gin v1.5.0
- github.com/llgcode/draw2d v0.0.0-20200110163050-b96d8208fcfc
- github.com/swaggo/gin-swagger v1.2.0
- github.com/swaggo/swag v1.6.5