Make server component separate and this module just install npm deps #70
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,6 @@ | ||
| # npm on IPFS | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. nicpick, can you make it centered. Just like libp2p https://github.com/libp2p/js-libp2p? |
||
|
|
||
| [](https://protocol.ai) | ||
| [](http://ipfs.io/) | ||
|
|
@@ -12,7 +11,9 @@ npm on IPFS | |
|
|
||
| > Install your favourite modules from the Distributed Web using IPFS. Have a cache always ready and share them in all your local networks. | ||
|
|
||
|  | ||
|
|
||
| ## Resources | ||
|
|
||
| - [The original demo video](https://vimeo.com/147968322) | ||
| - [Lengthy introduction in a blog post](http://daviddias.me/blog/stellar-module-management/) | ||
|
|
@@ -22,8 +23,6 @@ npm on IPFS | |
|
|
||
| [Alex Potsides](https://github.com/achingbrain) | ||
|
|
||
| ## Install this module | ||
|
|
||
| ```bash | ||
|
|
@@ -32,106 +31,62 @@ npm on IPFS | |
|
|
||
| # Usage | ||
|
|
||
| `ipfs-npm` wraps your chosen package manager (e.g. npm or yarn) with configuration to use IPFS to retrieve your dependences instead of over HTTP from the central npm registry. | ||
|
|
||
| In the directory with your `package.json` file, run: | ||
|
|
||
| ```bash | ||
| $ ipfs-npm install | ||
| 👿 Spawning an in-process IPFS node | ||
| 🗑️ Replacing old registry index if it exists | ||
| ☎️ Dialing replication master /ip4/127.0.0.1/tcp/40020/ipfs/QmeXyYCLSivUn5Ju31jjPBYNKdncbzzEf6zdN2DyrdLAbe | ||
| 📠 Copying registry index /ipfs/QmQmVsNFw3stJky7agrETeB9kZqkcvLSLRnFFMrhiR8zG1 to /npm-registry | ||
| 👩🚀 Starting local proxy | ||
| 🚀 Server running on port 57314 | ||
| 🎁 Installing dependencies with /Users/alex/.nvm/versions/node/v10.8.0/bin/npm | ||
| ... | ||
| ``` | ||
|
|
||
| ## CLI | ||
|
|
||
| ```bash | ||
| $ ipfs-npm --help | ||
| ipfs-npm | ||
|
|
||
| Installs your js dependencies using IPFS | ||
|
|
||
| Options: | ||
| --help Show help [boolean] | ||
| --version Show version number [boolean] | ||
| --package-manager Which package manager to use - eg. npm or yarn | ||
| [default: "npm"] | ||
| --ipfs-registry-index Where to download the registry index from if we | ||
| do not have it | ||
| [default: "https://replication.registry.js.ipfs.io"] | ||
| --ipfs-registry Where to download any packages that haven't made | ||
| it into the registry index yet from | ||
| [default: "https://registry.js.ipfs.io"] | ||
| --registry-upload-size-limit How large a file upload to allow when proxying | ||
| for the registry [default: "1024MB"] | ||
| --registry-update-interval Only request the manifest for a given module | ||
| every so many ms [default: 60000] | ||
| --ipfs-mfs-prefix Which mfs prefix to use | ||
| [default: "/npm-registry"] | ||
| --ipfs-node "proc" to start an in-process IPFS node, "go" or | ||
| "js" to spawn an IPFS node as a separate process | ||
| or a multiaddr that resolves to a running node | ||
| [default: "proc"] | ||
| --request-max-sockets How many concurrent http requests to make while | ||
| cloning the repo [default: 10] | ||
| --request-retries How many times to retry when downloading | ||
| manifests and tarballs from the registry | ||
| [default: 5] | ||
| --request-retry-delay How long in ms to wait between retries | ||
| [default: 1000] | ||
| --request-timeout How long in ms we should wait when requesting | ||
| files [default: 30000] | ||
| ``` | ||
|
|
||
| # Acknowledgements | ||
|
|
||
| This module takes a lot of inspiration from [reginabox](https://www.npmjs.com/package/reginabox). Big thank you to everyone that contributed with code or to the [discussion](https://github.com/ipfs/notes/issues/2) to make this happen. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This image was great btw
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you prefer it to the new image? Since #55 was opened I thought you wanted it updating?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see the js-ipfs repo for a good size
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, but the network of multiple npm registries is still super cool. Can we meet in the middle?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, I'll put it back in :)