This repository has been archived on 2023-12-16. You can view files and clone it, but cannot push or open issues or pull requests.
2017-12-10 19:25:07 +00:00
|
|
|
## Intergalactic
|
2017-12-10 07:27:01 +00:00
|
|
|
|
2017-12-10 19:46:03 +00:00
|
|
|
Intergalactic is a client-side gateway to the IPFS distributed web. After the
|
|
|
|
|
initial page load and bootstrapping, it pulls content from IPFS peers entirely
|
|
|
|
|
in your browser.
|
2017-12-10 07:27:01 +00:00
|
|
|
|
|
|
|
|
## Motivation
|
|
|
|
|
|
2017-12-10 19:46:03 +00:00
|
|
|
Intergalactic brings the distributed web to anyone with a web browser. This
|
|
|
|
|
allows web developers and content producers to publish their content through
|
|
|
|
|
IPFS, while still allowing users to consume it. All without having to download
|
|
|
|
|
any software or go through a centralized gateway.
|
2017-12-10 07:27:01 +00:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2017-12-10 19:25:07 +00:00
|
|
|
```shell
|
|
|
|
|
npm install
|
|
|
|
|
```
|
|
|
|
|
|
2017-12-10 07:27:01 +00:00
|
|
|
TODO
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
2017-12-10 19:46:03 +00:00
|
|
|
### Development
|
|
|
|
|
|
|
|
|
|
First, run the following from your copy of Intergalactic's source code:
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
node server.js
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Then, enter a URL like `http://localhost:3000/ipfs/<hash>` into your web
|
|
|
|
|
browser, where `<hash>` is the IPFS hash of some content on the network.
|
|
|
|
|
|
|
|
|
|
If the corresponding content is loadable, it will load and render in your
|
|
|
|
|
browser.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Production
|
|
|
|
|
|
2017-12-10 07:27:01 +00:00
|
|
|
TODO
|
