Git Product home page Git Product logo

cg.tools.codemap's Introduction

CG.Tools.CodeMap:


Build Status Github docs Azure DevOps coverage

What does it do?

A tool that generates a code map from a .NET assembly.

(Yes, we know Visual Studio already does that, but we run the Community Edition of Visual Studio and it doesn't do that)

Quick Note:

This project uses Syncfusion controls for the UI. We took that approach, as opposed to rolling our own, or using open source alternatives, because:

  • They're free, provided you sign up for the ridiculously generous Syncfusion Community License, HERE
  • They already written, which means we can focus on this tool rather than worring about reinventing an entire diagram control, from scratch.
  • They are supported, which is more than most open source control packages can say.
  • Did we mention they are FREE?? Seriously, go HERE and sign up!

If you do get your own Syncfusion license, you'll need to add your license key to the appSettings.json file, like this:

{
  "Syncfusion": "Your Syncfusion license here"
}

If you don't add your Syncfusion key to the appSetting.json, as shown above, you'll see a popup like this at runtime:

The main UI

Just press Close. The popup means the Syncfusion library didn't find a license, so it's starting in 'trial mode'.

It's alright, the CodeMap tool will work without the Syncfusion license.

UI walk through:

Here is the overal UI:

The main UI

Opening .NET assemblies is easy using the file|open menu command, or using the file option toolbar:

File Open

Filtering out unwanted assemblies is also easy, using the filter drop down:

File Open

Zooming the diagram up or down is easy, using the zoom controls:

File Open

Finally, you can layout a diagram at any time using the layout control:

File Open

How do I contact you?

If you've spotted a bug in the code please use the project Issues HERE

Is there any documentation?

There is developer documentation HERE

We also blog about projects like this one on our website, HERE

cg.tools.codemap's People

Contributors

martycook avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.