@nodesource/ncm-project

ncm-project

Set up a NCM project by installing this node module.

Usage

While NCM will work for any npm install on your system, it works at its best when it knows which project a npm install call belongs to. Therefore this module, ncm-project, creates or extends a .npmrc in your project folder and sets the registry value to your local NCM Desktop instance. All following npm install calls in this project will then be handled by NCM. Please make sure you're always running NCM Desktop for uninterrupted operation:

$ cd my-project
$ npm install --save @nodesource/ncm-project

The created .npmrc file should then be committed and therefore used by the whole team:

$ git add package.json package-lock.json .npmrc
$ git commit -m 'add NCM'

That's it, now just tell your teammates to run NCM Desktop too (if they don't do so already) and your project is fully configured for NCM!

Troubleshooting

If your npm install times out (ENOTFOUND) or just hangs without any explanation, please make sure your NCM Desktop app is up and running, and maybe restart it too.

Development

1. Clone this repository and run npm install
2. Create a temporary project
3. Inside that project, run npm install file:PATH-TO-THIS-REPOSITORY-ON-DISK

License

MIT