Skip to content

Commit

Permalink
Show an overview of dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrik Meijer committed Mar 20, 2019
1 parent 96b1bff commit b1b62b9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -66,6 +66,20 @@ webgme import plugin <plugin> <project>

where `<project>` is either `<github user>/<github repo>` 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/...__
Expand Down
1 change: 1 addition & 0 deletions images/webgme-packages.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b1b62b9

Please sign in to comment.