Code Monkey home page Code Monkey logo

codecharta's Introduction

CodeCharta

Build Status Quality Gate Analysis Quality Gate Visualization

CodeCharta by MaibornWolff

What is CodeCharta

CodeCharta is a beautiful tool to help you visualize and understand code. It can combine code metrics from multiple sources and visualize them using 3D tree maps. CodeCharta's two major parts are:

  • analysis: Command-Line-Tool for generating visualization data in the form of .cc.json files. It includes some pre-defined importers for e.g. SonarQube, SourceMonitor, SCM log information, generic csv data, as well as a command to validate and merge multiple data files.
  • visualization: GUI to visualize code metrics from .cc.json files. Imported files are validated using JSON Schema as defined in generatedSchema.json.

Screenshot of visualization

Usage

You can try the web visualization without any installation and explore the CodeCharta code (shown by default).

The visualization takes a .json file and to generate a new one you need to install the CodeCharta shell (ccsh). The are multiple ways to do so including non-global install. We'll use npm here because it is the most convenient:

npm i -g codecharta-analysis

For this example we'll also assume you want to analyze Junit4. CodeCharta is not limited to java code though.

# Download code base of your choice
git clone https://github.com/junit-team/junit4
# parse sources
ccsh sourcecodeparser junit4 -p junit4 -o junit4.source.cc.json
# done :)

You can now load this file (top left corner) either in the web or the local visualization:

npm i -g codecharta-visualization
  • If you want to analyze a different language or combine java metrics with git metrics, you should take a look at our Quick-Start Guide.
  • If you want to go further we have multiple how-tos. For example they'll explain how to integrate CodeCharta into your delivery pipeline.
  • If you want to know more about the ccsh api, please check the ccsh docs.

Feature request / Bug / Feedback

Have a bug, a feature request or any question? Please open a new issue. Feedback is always welcome.

Want to know what we are working on? Please click this Zenhub link or install the Zenhub Firefox/Chrome plugin.

Want to have even more information? Please check our news.

Further Information

Tool Information

codecharta's People

Contributors

alexhunziker avatar alschmut avatar bridgear avatar cctechuser avatar ce-bo avatar christian-eberhard avatar codecharta avatar dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar dmttr avatar felixherbst avatar fernandoes avatar hall-ma avatar ihsenbouallegue avatar jacob-kirimi avatar jaijopa avatar jannikr avatar jayeclark avatar med-h avatar mrpatpat avatar nearw avatar ngormsen avatar pixelpole avatar renovate[bot] avatar romanenkovladimir avatar shaman-apprentice avatar shivan-997 avatar ukinimod avatar xworkerbeex avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.