| 1 | # CodeCharta visualization
|
| 2 |
|
| 3 | [](https://travis-ci.org/MaibornWolff/codecharta)
|
| 4 |
|
| 5 | > CodeCharta by [MaibornWolff](https://www.maibornwolff.de)
|
| 6 |
|
| 7 | ## Jump to Section
|
| 8 |
|
| 9 | - [Installation](#installation)
|
| 10 | - [Tasks](#tasks)
|
| 11 | - [JSON structure](#json-structure)
|
| 12 | - [License](LICENSE.md)
|
| 13 |
|
| 14 | ## Installation
|
| 15 |
|
| 16 | Change working directory `cd <projectpath>/codecharta/visualization/`
|
| 17 |
|
| 18 | #### Install application for desktop usage with npm
|
| 19 |
|
| 20 | - install with `npm install codecharta-visualization -g`
|
| 21 | - run with `codecharta-visualization`
|
| 22 |
|
| 23 | #### Install application for desktop usage
|
| 24 |
|
| 25 | - Download or build [latest version](https://github.com/MaibornWolff/codecharta/releases/latest) for your system.
|
| 26 | - Doubleclick the system specific Runnable. You may be required to give it executable rights.
|
| 27 |
|
| 28 | #### Install project for development
|
| 29 |
|
| 30 | - Install node 8
|
| 31 | - Install dependencies `npm install`.
|
| 32 |
|
| 33 | Once you have installed the project, you can use all grunt tasks described in the next section.
|
| 34 |
|
| 35 | #### Install web application on server
|
| 36 |
|
| 37 | - Download or build latest web version.
|
| 38 | - Copy all files (dist/app or the downloaded directory) to a served directory which is accessible from the internet.
|
| 39 |
|
| 40 | ## Tasks
|
| 41 |
|
| 42 | #### Build
|
| 43 |
|
| 44 | `npm run build` builds the project in dist/app. This artifact is ready to be served as a web application.
|
| 45 | `npm run doc` generates the esdoc documentation in dist/doc/
|
| 46 |
|
| 47 | #### Test
|
| 48 |
|
| 49 | `npm run test` runs all unit tests on the source files in app/ and generates a coverage report in dist/coverage/.
|
| 50 | `npm run e2e` runs all e2e tests on the built app in headless mode.
|
| 51 |
|
| 52 | adding ":auto" to run target will run the tests in watch mode
|
| 53 |
|
| 54 | #### Run
|
| 55 |
|
| 56 | `npm run serve` starts a simple web server and serves the project on localhost:9000.
|
| 57 | `npm run start` starts the nwjs app
|
| 58 |
|
| 59 | #### Package
|
| 60 |
|
| 61 | `npm run package` packages the nwjs app
|
| 62 |
|
| 63 | #### Generate code
|
| 64 |
|
| 65 | `npm run g` runs the code generation via plop.
|
| 66 |
|
| 67 | You can generate the following modules:
|
| 68 |
|
| 69 | - "state service" - an empty service with corresponding test file
|
| 70 | - "ui module component" - an ui module with an empty component, all necessary files and tests
|
| 71 | - "util static class" - an empty static class with corresponding test file
|
| 72 |
|
| 73 | ## JSON structure
|
| 74 |
|
| 75 | [Example Data](/visualization/app/codeCharta/assets/sample1.cc.json)
|
| 76 |
|
| 77 | [JSON Schema](/visualization/app/codeCharta/util/schema.json)
|