Ecosyste.ms: Awesome

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

https://github.com/MaibornWolff/codecharta

CodeCharta visualizes multiple code metrics using 3D tree maps.
https://github.com/MaibornWolff/codecharta

3d-tree-maps analyzer angular angularjs data-visualization jest metrics node nodejs parser redux sonar sonarqube static-code-analysis temporal-coupling ts typescript visualization

Last synced: 3 days ago
JSON representation

CodeCharta visualizes multiple code metrics using 3D tree maps.

Host: GitHub
URL: https://github.com/MaibornWolff/codecharta
Owner: MaibornWolff
License: bsd-3-clause
Created: 2017-03-14T05:59:13.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2024-04-12T13:50:26.000Z (3 months ago)
Last Synced: 2024-04-12T14:31:40.611Z (3 months ago)
Topics: 3d-tree-maps, analyzer, angular, angularjs, data-visualization, jest, metrics, node, nodejs, parser, redux, sonar, sonarqube, static-code-analysis, temporal-coupling, ts, typescript, visualization
Language: TypeScript
Homepage: https://maibornwolff.github.io/codecharta/
Size: 79.6 MB
Stars: 168
Watchers: 13
Forks: 29
Open Issues: 129
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Lists

awesome-xr-3d-visualization - Codecharta

README

        


  


  

  


  CodeCharta

  




a beautiful tool to help you visualize and understand code in 3D.




    

        

    

    

        

    

  

    

  

      

  





Latest Release: 


 Analysis 1.125.0 | Visualization 1.126.0

[comment]: ##################################################################################

[comment]: 

[comment]: ##################################################################################





  Key Features •

  Experimental Features •

  How To Use •

  Feedback •

  Further Info •

  About



![Screenshot of visualization](screenshot.png)

## Key Features

- [CodeCharta Visualization](https://maibornwolff.github.io/codecharta/docs/visualization/):

  - CC visualizes code bases as 3D cities, so that you can understand it - view the [Web Demo](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json.gz&file=codecharta_analysis.cc.json.gz).

  - It uses code metrics from `.cc.json` files.

  - The imported files are validated using JSON Schema as defined in [generatedSchema.json](/visualization/app/codeCharta/util/generatedSchema.json).

  - You can change the way the file is displayed and save and later load it as a [Custom View](https://maibornwolff.github.io/codecharta/docs/custom-view/).

- [CodeCharta Analysis](https://maibornwolff.github.io/codecharta/docs/analysis/):

  - CC Analysis is used to calculate or to import metrics from third party tools for a code base.

  - It generates `.cc.json` files for CC Visualization through a Command-Line-Tool.

  - It includes some pre-defined importers for e.g. [SonarQube](https://maibornwolff.github.io/codecharta/docs/sonar-importer), [SourceMonitor](https://maibornwolff.github.io/codecharta/docs/sourcemonitorimporter), [Git](https://maibornwolff.github.io/codecharta/docs/git-log-parser), generic [CSV](https://maibornwolff.github.io/codecharta/docs/csv-importer) data

  - It also includes commands to [validate]() and [merge]() multiple `.cc.json` files.

## Requirements

For using CodeCharta the following needs to be installed on your system:

- Node >= 18

- Java >= 11, <= 21

## How To Use

### How to use **Visualization**?

- **Online:** You can try the [web visualization](https://maibornwolff.github.io/codecharta/visualization/app/index.html?file=codecharta.cc.json&file=codecharta_analysis.cc.json) without any installation and explore the CodeCharta code (shown by default).

- **Local:** See [here](visualization/README.md).

### How to use **Analysis**?

- Analysis is split into different parsers that generate `.cc.json` files. To run these parsers you need the [CodeCharta Shell](https://maibornwolff.github.io/codecharta/docs/ccsh/).

In this example we will generate a `.cc.json` from [JUnit4](https://github.com/junit-team/junit4) using the [Source Code Parser](https://maibornwolff.github.io/codecharta/docs/source-code-parser) (that parses java projects).

```bash

# Install codecharta-analysis globally

$ npm i -g codecharta-analysis

# Clone the junit4 repository

$ git clone https://github.com/junit-team/junit4

# Parse sources with CodeCharta Shell

$ ccsh sourcecodeparser junit4 -p junit4 -o junit4.source.cc.json

# Now you can upload `junit4.source.cc.json` to CodeCharta Visualization

```

> **Note**

> If you want to be guided through selecting the arguments. Just execute `ccsh` and you can run the parsers **interactively** with dialogs.

## Feedback

Have a **bug**, a **feature** request or any question? Please open [a new issue](https://github.com/MaibornWolff/codecharta/issues/new). Feedback is always welcome.

Want to know what we are **working on**? Please check out [our board](https://app.zenhub.com/workspaces/codecharta-workspace-5cd16b609795a865159e7107/board) or install the Zenhub Firefox/Chrome plugin.

Want to have even **more information**? Please check our [news](https://maibornwolff.github.io/codecharta/news/).

## Further Information

- [Docs](https://maibornwolff.github.io/codecharta/)

- [Quickstart Guide](https://maibornwolff.github.io/codecharta/docs/quick-start-guide/)

- [Coverage](https://maibornwolff.github.io/codecharta/visualization/coverage/lcov-report/)

- [Sonarqube Visualization](https://sonarcloud.io/project/overview?id=maibornwolff-gmbh_codecharta_visualization)

- [Sonarqube Analysis](https://sonarcloud.io/project/overview?id=maibornwolff-gmbh_codecharta_analysis)

## About CodeCharta

- [Releases](https://github.com/MaibornWolff/codecharta/releases)

- [Analysis - Changelog](analysis/CHANGELOG.md) | [Visualization - Changelog](visualization/CHANGELOG.md)

- [Contributing](CONTRIBUTING.md)

- [Code of Conduct](CODE_OF_CONDUCT.md)

- [License](LICENSE.md)

## License

MIT

---

> [maibornwolff.de](https://www.maibornwolff.de)  · 

> GitHub [@MaibornWolff](https://github.com/maibornwolff)