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
NOTE: STILL WIP - Expected v1.0.0 release by 9th Feb 2018 - Thank you
Overview is a package 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 preferred CLI
yarn global add app-overview
npm install -g app-overview- Go to the chosen app directory on the CLI -
overview App.js, this will build the config file and begin the visualisation. - Voila, open the overview.html file found in the Visual folder in your chosen browser - Enjoy!
Usage
overview _.js- Set entry file point + begin visualisationoverview -r- Remove Visual folder + reset.overview -h- Menu/helpoverview -p- View current path.
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
- Achim Bode - _Visualisation/D3/Design _ - achimbode
- Karsten Balogh - _Parsing/Data Algorithms _ - karstenba
- Nikita Kudryavtsev - Visualisation/D3/Design - palevoo
- Rainier Louis - CLI Environment/NPM - rainierlouis
License
This project is licensed under the MIT License - see the LICENSE.md file for details