├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2019 Cameron Yick 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # code-maps-frontend 2 | 3 | Exploring the idea of using interactive auto-generated diagrams to make frontend code more understandable. 4 | 5 | ## Presentations 6 | 7 | - [October 2019] React Conf: [Slides](https://slides.com/cameronyick/frontend-maps-react-conf-2019) / [Video](https://www.youtube.com/watch?v=SbreAPNmZOk) / [Transcript](https://www.datadoghq.com/videos/2020-auto-viz-of-the-frontend/) 8 | - [September 2019] React Boston : [Slides](https://slides.com/cameronyick/frontend-code-maps) / [Video](https://www.youtube.com/watch?v=iS3BNfbDXzE) 9 | 10 | Please feel welcome to send me maps of code that you have made or find elsewhere. 11 | 12 | ## Readings 13 | 14 | - Mentioned 15 | - Papers 16 | - [Software Reflexion Models: Bridging the Gap Between Source & High Level Models](https://www.cs.ubc.ca/~murphy/papers/rm/fse95.html) - Gail C. Murphy, Kevin Sullivan, David Notkin (1995) 17 | - [The Eyes Have It: A Taxonomy for Information Visualization](https://www.cs.umd.edu/~ben/papers/Shneiderman1996eyes.pdf) - Ben Schneiderman (1996) 18 | - Articles 19 | - [How Graphic Design Legend Massimo Vignelli Cracked the NYC Subway System](https://www.ceros.com/originals/massimo-vignelli-nyc-subway/) 20 | - Books 21 | - [How to Lie With Maps](https://www.amazon.com/How-Lie-Maps-Mark-Monmonier/dp/0226534219) - Mark Monmonier 22 | - [History of the World in 12 Maps](https://www.amazon.com/History-World-12-Maps/dp/0143126024) 23 | - Influenced but not directly quoted 24 | - [Questions Developers Ask During Change Tasks](http://pages.cpsc.ucalgary.ca/~sillito/work/fse2006.pdf) - Sillito (2006) 25 | - [Developers Ask Reachability Questions](https://dl.acm.org/citation.cfm?id=1806829) - Thomas LaToza & Brad Myers (2012) 26 | 27 | ## Tools 28 | 29 | - Visual + Node Based Programming (not necessarily JS) 30 | - [Visual Programming Codex](https://github.com/ivanreese/visual-programming-codex) 31 | - Collections on are.na such as [Frederic Brodbeck's](https://www.are.na/frederic-brodbeck/dataflow-programming) or [@round](https://www.are.na/maxim-leyzerovich/visual-programming-aedh3fsg8nm)'s. Still working on curating my own. 32 | 33 | - JS+TS Exploration 34 | - Files as Nodes 35 | - [ARKit](https://github.com/dyatko/arkit) 36 | - [Dependency-Cruiser](https://github.com/sverweij/dependency-cruiser) 37 | - [Madge](https://github.com/pahen/madge) 38 | - Functions as Nodes 39 | - Dynamic Callgraphs (Browser Devtools, [Flamebearer](https://github.com/mapbox/flamebearer)) 40 | - Python/C Tools: [Pyan](https://github.com/davidfraser/pyan) 41 | - Static Callgraphs: [js-callgraph](https://github.com/Persper/js-callgraph) 42 | - Variables as Nodes 43 | - [Observable Debugger](https://observablehq.com/@mbostock/notebook-visualizer) 44 | - [Reselect Devtools](https://github.com/skortchmark9/reselect-tools) 45 | - State Machines 46 | - [XState](https://github.com/davidkpiano/xstate) 47 | - [Sketch.systems](https://sketch.systems/) 48 | 49 | - Miscellaneous 50 | - [Python Callgraph](http://pycallgraph.slowchop.com/en/master/) 51 | - Data Engineering DAGs: Airflow and Dagster UI ([Compound nodes](https://dagster.readthedocs.io/en/0.5.9/sections/reference/reference.html#composite-solids)) 52 | - Visualizing Audio Transformation DAGs: [NFGrapherJS](https://github.com/spotify/NFGrapher/issues/5) 53 | 54 | - Influenced but not directly mentioned 55 | - Alternate network layouts (Hive plots, biofabric) 56 | - [The State of the Art in Visualizing Multivariate Networks](https://vdl.sci.utah.edu/publications/2019_eurovis_mvn/) 57 | - Generic graph analysis tools (Cytoscape + Gephi + Neo4j viewer) 58 | - Codecrumbs / Structuralizr TS / Dependo 59 | - Visual tools for performance/bundle optimization / code growth 60 | - Gource, Codeflower, hercules, git-of-theseus, bundlebuddy, etc 61 | - Bret Victor / Mindstorms (Papert) on tangible computing 62 | - Susie Lu's Keynote at Visfest Unconf 2019 - [Data Visualization Retrospective and Abstractions](https://www.susielu.com/data-viz/abstractions) 63 | 64 | ## Demos 65 | 66 | - [Electron Demos from Section 3](https://github.com/hydrosquall/interactive-js-map) 67 | - [Historical Train Schedule Remake](https://slides.com/cameronyick/metronorth-train-viz) 68 | - [Github Radial Repository](https://github.com/hydrosquall/untitled-code-map) - An Electron version of an demo by Amelia Wattenberger. Not from the presentation, but explores related ideas. 69 | 70 | ## Related Readings / Watches 71 | 72 | If you're read this far, you might also like these non-frontend specific resources: 73 | 74 | - [Visualizing The Architecture](https://www.youtube.com/watch?v=zcmU-OE452k) - Simon Brown, Devternity 2016. See also his site [codingthearchitecture.com](http://www.codingthearchitecture.com/) 75 | - [One-Page Design Docs](https://www.gdcvault.com/play/1012356/One-Page) - Stone Librande 76 | - Readings on Wayfinding 77 | - [Ruth Malan](https://www.ruthmalan.com/)'s public work on software architecture 78 | - [Your Code as a Crime Scene](https://www.youtube.com/watch?v=qJ_hplxTYJw) - Adam Tornhill (TED 2016) - Applying forensic psychology to understanding code 79 | - Trying out any GIS software (ArcGIS, ESRI, QGis) to get a feel for the potential of data-map overlays 80 | 81 | ## Contributing 82 | 83 | If you see a resource that you think would be appropriate to include in this list, I welcome pull requests/issues. 84 | 85 | In the future, the "recommended/cut for time" sections might split into a separate list of curated resources. In that case, this document will be limited to items specifically mentioned in the talk. 86 | --------------------------------------------------------------------------------