A regularly updating survey of the npm community
A regularly updating survey of the npm community.
Designed with love by NodeSource for our Node.js family.
The project itself makes extensive use of npm. Once installed, there's a total of 406 unique packages in the dependency tree. Most notably:
Before you can run the site on your machine, you'll need to ensure that you have the latest version of Node installed (especially important is
When you're ready, clone the repository from GitHub and install the visualisation's dependencies from npm:
git clone [email protected]:nodesource/understanding-npm.git cd understanding-npm npm install
Now, you should be ready to start the server up like so:
A sample dataset has been prepared and included in the repository for everybody's convenience, so you most likely won't have to deal with this directly. If, however, you'd still like to update the data locally you should check out the documentation in's README.md.
Each package should have its own independent
README.mddocumenting its purpose and usage. Some notes on the packages included in this project:
@unpm-scoped packages are part of the final project.
@nsight-scoped packages are part of the final project, but likely to be reused in future N|Sight projects.
@x-scoped packages are experiments, which are interesting for process documentation but not otherwise used in the final product.
gooeyis the only package unscoped package remaining (pending some reorganisation, and sorting out a new name).
Some other packages that were born from this project include:
Contributions are welcomed from anyone wanting to improve this project!
understanding-npm is Copyright (c) 2015 NodeSource and licensed under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE.md file for more details.