|
7 | 7 |
|
8 | 8 | ## What is this? |
9 | 9 |
|
10 | | -This project holds Node.js-based feature demonstrations for [Source++](https://github.com/sourceplusplus/sourceplusplus), |
11 | | -the open-source live coding platform. These demonstrations are meant to be used as a reference for how to use Source++ |
| 10 | +This project holds Node.js-based feature demonstrations for [Source++](https://github.com/sourceplusplus/sourceplusplus) |
| 11 | +, the open-source live coding platform. These demonstrations are meant to be used as a reference for how to use Source++ |
12 | 12 | in your own projects. |
13 | 13 |
|
14 | 14 | ## How to use? |
15 | 15 |
|
16 | 16 | Install the Source++ plugin via the JetBrains Marketplace by searching for: `Source++`. |
17 | | -Alternatively, you can download the Source++ plugin directly from [here](https://plugins.jetbrains.com/plugin/12033-source-). |
| 17 | +Alternatively, you can download the Source++ plugin directly |
| 18 | +from [here](https://plugins.jetbrains.com/plugin/12033-source-). |
18 | 19 |
|
19 | 20 | Once the plugin is installed, check out the demos below. Each demo contains instructions explaining how to use it. |
20 | 21 |
|
21 | | -> Note: You do not need to run this code to play with the demos. This application is hosted on our publicly accessible servers. |
| 22 | +> Note: You do not need to run this code to play with the demos. This application is hosted on our publicly accessible |
| 23 | +> servers. |
22 | 24 | |
23 | | -## Demos |
| 25 | +## Demo: Live Commands |
24 | 26 |
|
25 | | -### [Add Breakpoint](./src/command/add-breakpoint.js) |
| 27 | +> Live Commands allow you to execute user-defined actions. These commands have access to application runtime data and |
| 28 | +> can be used to gather metrics, trigger alerts, or perform other actions. |
| 29 | + |
| 30 | +#### [Add Breakpoint](./src/command/add-breakpoint.js) |
26 | 31 |
|
27 | 32 | This demonstration shows how to add a "non-breaking breakpoint" to a running application. The **Add Breakpoint** command |
28 | 33 | is useful for debugging production applications without impacting the end user. |
29 | 34 |
|
30 | | -For more information, see the [AddBreakpoint](./src/command/add-breakpoint.js) class. |
| 35 | +## Demo: Live Indicators |
| 36 | + |
| 37 | +> Live Indicators allow you to automatically display user-defined metrics in the IDE. These metrics can be used to |
| 38 | +> monitor the health of your application or provide insight into the current state of the application. |
| 39 | + |
| 40 | +#### [Failing Endpoint](./src/indicator/failing-endpoint.js) |
| 41 | + |
| 42 | +This demonstration shows how failing endpoints can be detected and displayed in the IDE. The **Failing Endpoint** |
| 43 | +indicator is useful for identifying endpoints that are actively failing and require attention. |
| 44 | + |
| 45 | +#### [High Load Endpoint](./src/indicator/high-load-endpoint.js) |
| 46 | + |
| 47 | +This demonstration shows how high load endpoints can be detected and displayed in the IDE. The **High Load Endpoint** |
| 48 | +indicator is useful for identifying endpoints that are experiencing high load and may require scaling. |
| 49 | + |
| 50 | +#### [Slow Endpoint](./src/indicator/slow-endpoint.js) |
| 51 | + |
| 52 | +This demonstration shows how slow endpoints can be detected and displayed in the IDE. The **Slow Endpoint** indicator |
| 53 | +is useful for identifying endpoints that are experiencing slow response times and may require optimization. |
| 54 | + |
| 55 | +#### [Unused Endpoint](./src/indicator/unused-endpoint.js) |
| 56 | + |
| 57 | +This demonstration shows how unused endpoints can be detected and displayed in the IDE. The **Unused Endpoint** |
| 58 | +indicator is useful for identifying endpoints that are not being used and may be able to be removed. |
31 | 59 |
|
32 | 60 | ## Bugs & Features |
33 | 61 |
|
|
0 commit comments