Npm (software): Difference between revisions
Created page with "NPM is a package manager for JavaScript and TypeScript projects. ==Usage== ==Publishing== # Create an account at [https://npmjs.org https://npmjs.org]. # Login to npm using..." |
|||
| Line 9: | Line 9: | ||
# Initialize a <code>package.json</code> using <code>npm init</code>. | # Initialize a <code>package.json</code> using <code>npm init</code>. | ||
#* I recommend using a scoped name <code>@''username/package-name''</code>. | #* I recommend using a scoped name <code>@''username/package-name''</code>. | ||
# Make a build e.g. using webpack. | # Make a UMD build e.g. using webpack. | ||
#* 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 by `npm install [dir]` from another project. | |||
# 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:46, 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 by `npm install [dir]` from another project.
- Upload to npm
npm publish --access public