From b1b62b92e230bffec3a0fcb645beb7ab73601ad6 Mon Sep 17 00:00:00 2001 From: Patrik Meijer Date: Wed, 20 Mar 2019 15:53:49 -0500 Subject: [PATCH] Show an overview of dependencies --- README.md | 16 +++++++++++++++- images/webgme-packages.svg | 1 + 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 images/webgme-packages.svg diff --git a/README.md b/README.md index 4fbcc42..c61e9bc 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ # WebGME CLI The WebGME cli is a tool for managing WebGME apps. Specifically, it provides a command line interface for creating, removing, installing from other WebGME apps, (etc) for various WebGME components. -To view a listing of components and applications that have been published on npmjs and are openly and freely available check out [the list of extensions at webgme.org](https://webgme.org/?tab=extensions). +To view a listing of components and applications that have been published on [npmjs](https://www.npmjs.com/) and are openly and freely available check out [the list of extensions at webgme.org](https://webgme.org/?tab=extensions). A "component" in webgme is general term for one of the following: - [plugin](https://github.com/webgme/webgme/wiki/GME-Plugins) @@ -66,6 +66,20 @@ webgme import plugin where `` is either `/` or the npm project name. +## Dependency overview +If you're new to nodejs/npm, npm is the package manager that comes bundled with any nodejs installation. +The full documentation can be found [here](https://docs.npmjs.com/), some areas of interest are: + +- [global npm packages](https://docs.npmjs.com/downloading-and-installing-packages-globally) +- [dependencies](https://docs.npmjs.com/files/package.json#dependencies) +- [devDependencies](https://docs.npmjs.com/files/package.json#devdependencies) +- [peerDependencies](https://docs.npmjs.com/files/package.json#peerdependencies) + +The diagram below gives an overview of how different webgme packages are related. +All of these are published on [npmjs.com](https://www.npmjs.com/). + + ![webgme-packagse](images/webgme-packages.svg "An overview of who depends on whom") + # FAQ + __Tried loading "coreplugins/XXXXGenerator/XXXXGenerator" at xxxxx/src/../node_modules/webgme/src/plugin/coreplugins/...__ diff --git a/images/webgme-packages.svg b/images/webgme-packages.svg new file mode 100644 index 0000000..9e84751 --- /dev/null +++ b/images/webgme-packages.svg @@ -0,0 +1 @@ + \ No newline at end of file