Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ellerbrock/npm-tutorial
:tada: Publishing NPM Packages for Developers
https://github.com/ellerbrock/npm-tutorial
Last synced: 16 days ago
JSON representation
:tada: Publishing NPM Packages for Developers
- Host: GitHub
- URL: https://github.com/ellerbrock/npm-tutorial
- Owner: ellerbrock
- License: cc-by-4.0
- Created: 2016-05-23T21:04:22.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-10-30T16:57:02.000Z (about 8 years ago)
- Last Synced: 2024-05-18T21:47:19.946Z (7 months ago)
- Homepage: https://ellerbrock.github.io/npm-tutorial
- Size: 35.2 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-koa - Publishing NPM Packages for Developers - Introduction how to write and publish npm Modules. (Other Web Development Lists)
README
# npm Workflow
## Development, Build and Deployment
[](https://github.com/ellerbrock/javascript-badges/) [](https://github.com/ellerbrock/open-source-badge/) [](https://gitter.im/frapsoft/frapsoft/)
## Status
[](https://travis-ci.org/ellerbrock/publishing-npm-packages)
**Info:** Greeen Build Status means there should be no Deadlinks in this List.
You can find the Testfiles on [travis-deadlink-scanner](https://github.com/ellerbrock/travis-deadlink-scanner).
## Resources
- [Node.js for Developers](https://github.com/ellerbrock/node.js-for-developers)
- [NPM Developer Guide](https://docs.npmjs.com/misc/developers)
- [Common.js Module Specs](http://www.commonjs.org/specs/modules/1.0/)
- [NPM Module Best Practices](https://github.com/mattdesl/module-best-practices)
- [Faster & Cleaner Module Workflow](https://mattdesl.svbtle.com/faster-and-cleaner-modules)
- [Getting Started with Node and NPM](https://github.com/Microsoft/nodejs-guidelines/blob/master/getting-started.md)
- [Writing cross-platform Node.js](http://shapeshed.com/writing-cross-platform-node/)
- [Choosing a licence for your Open Source Project](https://github.com/ellerbrock/tutorial-choosing-open-source-licence)
- [Awesome NPM](https://github.com/sindresorhus/awesome-npm)
- [Awesome Node.js](https://github.com/sindresorhus/awesome-nodejs)
- [Awesome TypeScript](https://github.com/ellerbrock/awesome-typescript)
- [10 Cool Things You Probably didn't realize npm could do](http://blog.izs.me/post/1675072029/10-cool-things-you-probably-didnt-realize-npm-could-do)
- [Semantic Versioning](http://semver.org/)
- [Creating and Publishing a Node.js Module](https://quickleft.com/blog/creating-and-publishing-a-node-js-module/)
- [Creating Node.js modules](https://docs.npmjs.com/getting-started/creating-node-modules)
- [How to write Node.js Modules](http://www.hacksparrow.com/how-to-write-node-js-modules.html)
- [module-generator](https://github.com/hughsk/module-generator)
- [npmignore](https://www.npmjs.com/package/npmignore)
## Node.js Installation
### nvm
For OS X and Linux User i recommend using the Node Version Manager [nvm](https://github.com/creationix/nvm).
`curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.7/install.sh | bash`
### OS X
with [curl](https://curl.haxx.se/)
curl http://npmjs.org/install.sh | sh
or with [Homebrew](http://brew.sh/)
`brew update && brew install node`
If you want to choose [another node version](https://github.com/Homebrew/homebrew-versions) (in this example the long-term support for node 4) you can do so:
brew tap homebrew/versions
brew install homebrew/versions/node4-lts
brew link --overwrite node4-lts
### Linux
curl http://npmjs.org/install.sh | sudo sh
or on a apt based linux version via
apt-get update && apt-get install npm
## Configuration
npm set init.author.name "Your Name"
npm set init.author.email "[email protected]"
npm set init.author.url "http://yourblog.com"
npm adduser
Then create a `package.json` and publish it:
cd /path/to/your-project
npm init
npm install -g pakmanager
# this shows you dependencies as you `require`d them
pakmanager deps
# now edit `package.json` and add any deps you forgot about
npm publish ./
## User Managment
- `npm owner add username package` - add user to package
- `npm owner rm username package` - remove user from package
- `npm owner ls username package` - list users from package
## Beta and Release versions
If you don't want something to install by default
`npm publish ./ --tag beta`
If you published a bugfix as v1.0.7 and need to set v1.1.3 back to latest
git checkout v1.0.7
npm publish ./
git checkout v1.1.3
npm tag [email protected] latest
## Remove a package from the registry
`npm unpublish package`
Its considered bad behavior to remove versions of a library others depending ong. A better way to is to mark the package as deprecated
`npm deprecate package`
### Social Media
*Get the latest News about Web Development, Open Source, Tooling, Server & Security*
[](https://twitter.com/frapsoft/)[](https://www.facebook.com/frapsoft/)[](https://plus.google.com/116540931335841862774)[](https://gitter.im/frapsoft/frapsoft/)[](https://github.com/ellerbrock/)
### License
This work by Maik Ellerbrock is licensed under a Creative Commons Attribution 4.0 International License.