Skip to content

AsaAyers/AppExplorer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

333 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AppExplorer

AppExplorer connects VS Code and Miro so your architecture diagrams can stay linked to the code they describe.

Instead of drawing a diagram once and letting it drift out of date, you can map real functions, classes, and code regions to cards on a board, then use the board to navigate back to the implementation.

What AppExplorer helps you do

  • Turn code into board cards linked to real symbols
  • Build diagrams by walking the codebase
  • Click cards in Miro and jump back to code in VS Code
  • Keep architecture notes, arrows, screenshots, and context around real code references

AppExplorer does not auto-generate architecture diagrams for you. It helps you build one gradually, using the code you decide is worth mapping.

How it works

  1. Install Miro app and VSCode extension
  2. Open a codebase in VS Code.
  3. Open AppExplorer in Miro and choose Start VSCode session.
  4. Move your cursor inside a function, class, or other symbol.
  5. AppExplorer shows the symbols around your cursor.
  6. Drag a card onto the board to add that code to your diagram.
  7. Select a card later to navigate back to the linked code.

Best fit

AppExplorer is a good fit when you want to:

  • explain a system to teammates
  • map an architecture as you learn it
  • document important flows without losing the connection to implementation
  • create diagrams that remain useful after the first draft

Before you start

AppExplorer depends on language-server symbol information, so it works best in projects and languages where VS Code can already identify functions, classes, and other code symbols.

You will usually get the best results when your cursor is inside a symbol, not on blank lines, imports, or the top of the file.

Commands

  • AppExplorer: Navigate to Card
  • AppExplorer: Disconnect Session

Learn more

Feedback

If you want to report a bug, request a feature, or share how you would use AppExplorer, visit:

https://appexplorer.dev

About

AppExplorer@<0.2 is a prototype that runs on localhost. It needs a real URL, which means hosting and costs. I intend to use what I learned here in my solo-project to make it a full Miro App

Resources

License

Stars

Watchers

Forks

Contributors