codecharta-visualization

CodeCharta visualization

CodeCharta by MaibornWolff

Jump to Section

• Installation
• Tasks
• JSON structure
• License

Installation

Change working directory cd <projectpath>/codecharta/visualization/

Install application for desktop usage with npm

• install with npm install codecharta-visualization -g
• run with codecharta-visualization

Install application for desktop usage

• Download or build latest version for your system.
• Doubleclick the system specific Runnable. You may be required to give it executable rights.

Install project for development

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed. From your command line run:

# Clone the CodeCharta repo
$ git clone https://github.com/MaibornWolff/codecharta.git
# Navigate to Visualization
$ cd codecharta/visualization
# Installation. If you're on Apple Silicon, you have to do `npm_config_nwjs_process_arch=x64 npm install` instead (see https://github.com/nwjs/npm-installer/issues/83).
$ npm install
# Run the development server
$ npm run dev
# Upload any .cc.json!

Once you have installed the project, you can use all tasks described in the next section.

Tasks

Build

npm run build builds the project in dist/app. This artifact is ready to be served as a web application.

Test

• npm run test runs all unit tests on the source files in app/ and generates a coverage report in dist/coverage/.
• npm run e2e runs all e2e tests on the built app in headless mode. You have to stop your running dev-webserver and execute npm run build first. To follow/watch the steps the e2e test is performing, deactivate headless mode in jest-puppeteer.config.js (and maybe set the slowMo parameter).

adding ":auto" to run target will run the tests in watch mode

Run

npm run dev starts a simple web server and serves the project on localhost:3000. npm run start starts the nwjs app

Package

npm run package packages the nwjs app

JSON structure

Example Data

JSON Schema