moethu / codenutrition

Nutrition Facts for Code

Home Page:http://code.grevit.net:8084

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Code Nutrition

codenutrition

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.

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

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

Requirements for building the service

Go Report Card

  • 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

About

Nutrition Facts for Code

http://code.grevit.net:8084

License:MIT License


Languages

Language:Go 50.2%Language:JavaScript 30.7%Language:HTML 19.1%