You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quick-start.md
+81-55Lines changed: 81 additions & 55 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
sidebar_position: 1
3
3
---
4
4
5
-
# Quick Start
5
+
# Getting Started
6
6
7
7
This practical tutorial will walk you through configuring Noesis step by step. After completing it, you'll be able to **see** - "See how your system REALLY works" 🙂
8
8
@@ -154,7 +154,9 @@ namespace NoesisConfig
154
154
}
155
155
```
156
156
157
-
Play with the DSL if you want. You should be able additional versions of methods e.g. allowing to specify repository branch (which might be useful if your primary branch is not `main`). Check if the project correctly compiles
157
+
Play with the DSL if you want. You should be able additional versions of methods e.g. allowing to specify repository branch (which might be useful if your primary branch is not `main`). You may add multiple configuration files - they will be recognized by Noesis as separate systems to scan.
158
+
159
+
Check if the project correctly compiles - otherwise Noeis won't be able to work with it.
158
160
159
161
```bash
160
162
dotnet build
@@ -204,7 +206,9 @@ docker run \
204
206
[10:05:15 INF] Full analysis for system DDD Starter Dotnet finished in 62.92s.
205
207
```
206
208
3. Go back to the main page and click "Basic mode" to view the scan results. Choose your result.
207
-
4. Click **Modules** view - you should see modules created from your project's namespaces in the tree on the left, after you expand it
209
+
4. Click **Modules** view - you should see modules created from your project's namespaces in the tree on the left, after you expand it. Here's how it may look like:
210
+
211
+

208
212
209
213
210
214
@@ -214,46 +218,55 @@ docker run \
214
218
215
219
Now we'll add entry points configuration - entry points to your system's business logic. These often correspond to REST API endpoints or command handling methods.
216
220
221
+
:::info
222
+
From now on, it might be worth knowing that **the architecture conventions examples presented in the code-snippets below were created according to the architecture of an opensource project [Grandnode2](https://github.com/grandnode/grandnode2)**. This information might help you compare what is the exact application code corresponding to the presented usages of Noesis DSL. In addition you can find a full configuration for this projects in our examples repository on [Github](https://github.com/NoesisVision)
223
+
:::
224
+
217
225
### 5.1: Add Entry Points Configuration
218
226
219
227
Update `ArchitectureConventions.cs`, adding entry points configuration. The configuration depends on your project patterns, but if you use typical `CommandHandlers` with method `Handle` it may look like that:
220
228
221
229
```csharp
222
-
using Noesis.Parser;
230
+
using Noesis.Parser.CodeParsing.Configuration;
231
+
using Noesis.Parser.Configuration;
232
+
using Noesis.Tags;
223
233
224
234
namespace NoesisConfig
225
235
{
226
-
[FullAnalysisConfig]
227
-
public static FullAnalysisConfig Create() => FullAnalysisConfigBuilder
.Humanize(LetterCasing.Title))) // Create readable behavior name
244
-
.Build();
254
+
$"{method.ContainingType.Name.Replace("CommandHandler", string.Empty)}") // Create readable behavior name
255
+
)) // Creates modules from namespaces
256
+
.Build();
257
+
}
245
258
}
246
259
```
247
-
For more options on how to configure entry point detection please refer to the [Conventions Documentation](configure.md#entry-points-configuration)
260
+
For more options on how to configure entry point detection please refer to the [Conventions Documentation](configure.md#entry-points-configuration). You may also check available
248
261
249
262
### 5.2: Run with Entry Points Configuration
250
263
251
-
Run the container again with updated configuration.
264
+
At the moment, you need to restart container after every configuration change (we are plan to improve it in the near future).
2. Go to the **Entry Points** section in the newest scan result and click a plus icon of the entry points - you should see services from your system used by this entry point.
330
353
3. Add another entry point from the list which potentially share some services with the first one. You should see what are the common services
331
354
355
+

356
+
332
357
🎉 **Great Success!** You now have completed a first basic visualization of your system!
333
358
334
359
## What You've Achieved
@@ -361,7 +386,8 @@ Now that you have basic visualization, you can:
361
386
362
387
## Need Help?
363
388
389
+
- Get instant help on our [Discord server](https://discord.gg/QF5PMX4Dqg)
364
390
- Check the [full installation guide](/docs/setup)
0 commit comments