|
1 | 1 | # CodeRadarVisualization |
2 | 2 |
|
3 | | -## Installing dependencies |
4 | | -After checking out the project to your local harddrive, just install all needed dependencies with npm: |
| 3 | +## Background |
| 4 | +In the context of my bachelor thesis, a prototypic application is developed that can **visualize the structure and quality of software**. |
| 5 | +With the **comparison of different versions** of this software, also tendencies of the **software's evolution** shall be revealed and become visible. |
| 6 | +According to that, the aim of this application is that developers and also project managers are able to **intuitively explore and localize flaws and possibilities to improve their projects**. |
| 7 | +Therefore, **results of static code analyses are visualized** in the form of a city with buildings representing the files and districts representing the modules of the project. |
| 8 | + |
| 9 | +## How to install |
| 10 | +### Checkout and install dependencies |
| 11 | +After checking out the project to your local harddrive, just can install all needed dependencies with npm: |
5 | 12 | ``` |
6 | 13 | npm install |
7 | 14 | ``` |
8 | 15 |
|
9 | | -## Transform to ES5 |
10 | | -Because ES6 is used for writing the JavaScript code, you need to transpile the code into ES5. You can easily do that with the help of gulp: |
| 16 | +### Coderadar |
| 17 | +The application is yet designed to visualize results of static code analyses of the tool **Coderadar** exclusively. So at the moment, you would need to have a locally running Coderadar server and a fully analyzed sample project in order to use the application. |
| 18 | +To see how this works, just have a look at the [GitHub project](https://github.com/reflectoring/coderadar) and at the [administration guide](http://www.reflectoring.io/coderadar/current/docs/admin.html). |
| 19 | + |
| 20 | +## How to develop |
| 21 | +### Transpiling to ES5 |
| 22 | +Because ES6 is used for writing the JavaScript code, you need to transpile the code into ES5 to make the app run in all browsers. You can easily do that with the help of gulp: |
11 | 23 | ``` |
12 | 24 | gulp |
13 | 25 | ``` |
14 | | -To make the development a lot more comfortable, you can also start a code watcher with gulp. It will automatically transpile the JavaScript code to ES5 whenever it detects a change: |
| 26 | +To make the development a lot more comfortable, you can also start a code watcher with gulp. It will automatically transpile the JavaScript code to ES5 whenever it detects a change in the source files: |
15 | 27 | ``` |
16 | 28 | gulp watch |
17 | 29 | ``` |
18 | 30 |
|
19 | | -## Execute tests |
| 31 | +### Execute tests |
20 | 32 | To make sure the code works properly, you can run unit tests with |
21 | 33 | ``` |
22 | 34 | npm test |
|
0 commit comments