JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 43
  • Score
    100M100P100Q54709F
  • License ISC

Package Exports

  • app-overview

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (app-overview) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

OVERVIEW

Overview is an npm module that creates a visual representation of the user's application structure.

An invaluable tool for developers who will be able to immediately see the layout of the application folder and how the files within connect with one another.

Getting Started

  • In your chosen CLI - yarn add (TBA) --dev.
  • Go to the chosen app directory on the CLI - ov App.js, this will build the config file and begin the visualisation.
  • Voila, open the visual.html found in the Visual folder in your chosen browser.
  • Enjoy!

Usage

  • ov _.js - Set entry file point + begin visualisation
  • ov -h - Menu/help
  • ov -r - Remove Visual folder + reset.

Built With

  • d3 - Data driven visualisation
  • node - Modular CLI config & system filing
  • webpack - Bundling application for npm consumption
  • command line args - Parsing CLI options

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details