@agentofuser/ipfs-deploy

Zero-Config CLI to Deploy Static Websites to IPFS

Showing:

Popularity

Downloads/wk

2

GitHub Stars

852

Maintenance

Last Commit

3mos ago

Contributors

20

Package

Dependencies

21

Size (min+gzip)

1804.0KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Deprecated!
Package ipfs-deploy (unscoped) is the continuation of this package

Readme

ipfs-deploy

standard-readme
compliant

Upload static website to IPFS pinning services and optionally update DNS.

The goal of ipfs-deploy is to make it as easy as possible to deploy a static website to IPFS.

Install

npm install -g ipfs-deploy

You can call it either as ipd or as ipfs-deploy:

ipd public/
ipfs-deploy public/

You can run it directly with npx so you don't need to install it:

npx ipfs-deploy _site

It will deploy to a public pinning service and give you a link to ipfs.io/ipfs/QmHash so you can check it out.

Usage

Please check md/usage.md for further information!

API

There is an API so, however it is somewhat unstable and subject to change.

Please check md/api.md for further information!

Contributing

Please check md/contributing.md for further information!

Users

If you use this package to deploy your website, please send a pull request so I can add it to the Users section in the README. (I reserve the right to exercise discretion.)

License

BlueOak-1.0.0 OR BSD-2-Clause-Patent OR MIT © Agent of User

(The first two are the most permissive possible ever, more than MIT, which doesn't have a patent waiver. Use whichever satisfies your lawyer better.)

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial