Having trouble communicating the problems in your code base? Look no further, CodeCharta is able to visualise or even print your code base in 3D! While showing you lots of different metrics to help you decide what to tackle next. Without sharing your code! CodeCharta is an open source project mainly developed by MaibornWolff. You can find everything you need in our Documentation.
Our Shell is the heart of CodeCharta. It allows you to import metrics from various sources or parse your code base. You need it to generate the data needed for our Web Studio. It supports different imports from Sonar, Tokei, Code Maat, Source Monitor, or even CSV files! Or you can parse your code base directly with various parsers for Git Log, SVN Log, Source Code, and Raw Text.
None of this will be uploaded or shared somewhere, everything happens on the client side. You can even run it locally if you want.
Web Studio (Visualisation)
Our Web Studio allows you to visualize your code base in 3D. It takes the results from our Shell and displays them in a city-like map. You can move around your code base, zoom in and out, and see the metrics of your code base in a 3D map. Files with metrics become buildings where the area, height and color represent different metrics, you can freely choose! Makes it easy to see the hotspots in your code base and find areas for improvement. Ever wanted to touch that huge complex service? Download your map as a 3D model and print your code base! Take it in your hands and show it to your colleagues.
None of this will be uploaded or shared somewhere, everything happens on the client side. You can even run it locally if you want.
Compare two maps and see the delta between them. This allows you to see the changes in your code base over time.
You can find our prefered way to get start under Documentation - Quick Start Guide.
But if you already know what to do, here is how you install our CCSH.
# Install our codecharta shell globally
$ npm i -g codecharta-analysis
# Check if it is installed
$ ccsh - h
# done :)Do you have a bug, feature request, or question? Please open a a new issue. Feedback is always welcome.
Want more information? Check out our documentation and news.
Your company needs professional support to analyse your code base? We offer a service to help you with that.
Get a report about your hotspots and areas for improvement. This is currently free of charge.
Click the link to learn more: Code Quality Insights
A full Software Health Check for your codebase and everything around it. Click the link to learn more: Software Health Check
- Documentation
- Quickstart Guide
- Releases
- Coverage
- Analysis - Changelog | Visualization - Changelog
- Contributing
- Code of Conduct
- License
BSD-3-Clause License
Made with ❤ by MaibornWolff · GitHub @MaibornWolff
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
![@renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=64&v=4){kind=small}
