Npm (software): Difference between revisions
| Line 12: | Line 12: | ||
#* Fill in all the details in <code>package.json</code>. | #* Fill in all the details in <code>package.json</code>. | ||
#* For publishing the most important are: name, version, description, main, module, author, repository, license, files, homepage. | #* For publishing the most important are: name, version, description, main, module, author, repository, license, files, homepage. | ||
# Test your package | # Test your package. | ||
#* Run your own tests using `npm run test`. | |||
#* Install to another package using `npm install [dir]`. | |||
# Upload to npm | # Upload to npm | ||
# | #: <pre>npm publish --access public</pre> | ||
==Resources== | ==Resources== | ||
* [[https://zellwk.com/blog/publish-to-npm/ https://zellwk.com/blog/publish-to-npm/ zellwk publish to npm] | * [[https://zellwk.com/blog/publish-to-npm/ https://zellwk.com/blog/publish-to-npm/ zellwk publish to npm] | ||
Revision as of 14:47, 17 August 2020
NPM is a package manager for JavaScript and TypeScript projects.
Usage
Publishing
- Create an account at https://npmjs.org.
- Login to npm using
npm login. - Initialize a
package.jsonusingnpm init.- I recommend using a scoped name
@username/package-name.
- I recommend using a scoped name
- Make a UMD build e.g. using webpack.
- Fill in all the details in
package.json. - For publishing the most important are: name, version, description, main, module, author, repository, license, files, homepage.
- Fill in all the details in
- Test your package.
- Run your own tests using `npm run test`.
- Install to another package using `npm install [dir]`.
- Upload to npm
npm publish --access public