https://github.com/remarkablemark/npm-package-test
https://github.com/remarkablemark/npm-package-test
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/remarkablemark/npm-package-test
- Owner: remarkablemark
- Created: 2020-03-25T23:43:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-27T01:11:46.000Z (about 5 years ago)
- Last Synced: 2025-02-14T08:44:58.000Z (4 months ago)
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# npm packages on GitHub
This goes over how to [install npm packages on GitHub](https://docs.npmjs.com/cli/install).
## Prerequisites
For an npm package to be valid, the `package.json` must:
- be parseable
- be located at the repository root
- contain the fields:
- name
- version
For example:
```json
{
"name": "my-npm-package",
"version": "1.2.3"
}
```
## Install package
### master
To install a package on GitHub at the latest (master) commit:
```sh
# npm install /
$ npm install remarkablemark/npm-package-test
```
This is the same as:
```sh
# npm install :/
$ npm install github:remarkabelmark/npm-package-test
```
And this:
```sh
# npm install https://github.com//.git
$ npm install https://github.com/remarkablemark/npm-package-test.git
```