Skip to content

Commit

Permalink
v0.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
fbaiodias committed Feb 1, 2016
1 parent 1f5f61f commit f2ad43e
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 22 deletions.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,42 @@
ipfs-chrome-station
===

Chrome extension that let's have a look at your IPFS node stats
Chrome extension that let's you access [IPFS](https://ipfs.io) urls seamlessly from your local [IPFS node](https://ipfs.io/docs/install/), and take a look at its stats.

Based on [IPFS station](https://github.com/ipfs/station/) and [react-chrome-extension-boilerplate](https://github.com/jhen0409/react-chrome-extension-boilerplate)
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)
[![Available in the Chrome Web Store](https://developer.chrome.com/webstore/images/ChromeWebStore_BadgeWBorder_v2_206x58.png)](https://chrome.google.com/webstore/detail/ipfs-station/kckhgoigikkadogfdiojcblegfhdnjei)

Based on [react-chrome-extension-boilerplate](https://github.com/jhen0409/react-chrome-extension-boilerplate), [ipfs-station](https://github.com/ipfs/station/) and [ipfs-firefox-addon](https://github.com/lidel/ipfs-firefox-addon) *(if you're using Firefox, make sure to check it out)*.

### Demo

![demo](https://raw.githubusercontent.com/xicombd/ipfs-chrome-station/master/demo.gif)

### Features

- Icon with badge that shows if the node is running, and how many peers are connected to it
- Clicking on the icon opens popup menu with useful operations:
- See stats of the IPFS node
- Toggle redirection to the IPFS node
- Open IPFS node WebUI
- Open extension options (more about this bellow)
- When redirection is on, requests to `https?://*/(ipfs|ipns)/$RESOURCE` are replaced with `http://localhost:8080/(ipfs|ipns)/$RESOURCE`
- Options menu that let's you customize several parameters:
- IPFS node host
- IPFS node port
- IPFS node API port
- API stats polling interval
- Toggle redirection

## Installation
### Installation

```bash
# git clone ...

npm install
```

## Development
### Development

* Run script
```bash
Expand All @@ -27,20 +47,20 @@ npm run dev
* Go to [chrome://extensions/](chrome://extensions/) and check `Developer Mode` box
* Click `Load unpacked extension...` and select the `dev` folder

## Build
### Build

```bash
# build files to './build'
npm run build
```

## Build & Compress ZIP file
### Build & Compress ZIP file

```bash
# compress build folder to archive.zip
npm run compress
```

## LICENSE
### LICENSE

[MIT](LICENSE)
2 changes: 1 addition & 1 deletion app/popup/js/screens/menu/start.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export default class StartScreen extends Component {
<p>Oh snap, it looks like your node<br/>
is not running yet.</p>
<p>Please start it by running<br/>
<code>API_ORIGIN="*" ipfs daemon</code><br/>
<code>ipfs daemon</code><br/>
on your terminal.</p>
</div>
</div>
Expand Down
8 changes: 4 additions & 4 deletions chrome/manifest.dev.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"version": "0.0.1",
"name": "ipfs-station",
"version": "0.0.2",
"name": "IPFS Station",
"manifest_version": 2,
"description": "IPFS station",
"description": "This extension let's you access IPFS urls seamlessly from your local IPFS node, and take a look at its stats.",
"browser_action": {
"default_title": "ipfs-station",
"default_title": "IPFS Station",
"default_popup": "popup.html"
},
"icons": {
Expand Down
8 changes: 4 additions & 4 deletions chrome/manifest.prod.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"version": "0.0.1",
"name": "ipfs-station",
"version": "0.0.2",
"name": "IPFS Station",
"manifest_version": 2,
"description": "IPFS station",
"description": "This extension let's you access IPFS urls seamlessly from your local IPFS node, and take a look at its stats.",
"browser_action": {
"default_title": "ipfs-station",
"default_title": "IPFS Station",
"default_popup": "popup.html"
},
"icons": {
Expand Down
2 changes: 1 addition & 1 deletion chrome/views/popup.jade
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ html
body { width: 500px; min-height: 280px }

body
#root(class='todoapp')
#root
script(src=env == 'prod' ? '/popup.bundle.js' : 'http://localhost:3000/js/popup.bundle.js')
3 changes: 1 addition & 2 deletions gulpfile.babel.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,7 @@ gulp.task('webpack-dev-server', () => {
let myConfig = Object.create(devConfig)
new WebpackDevServer(webpack(myConfig, (err, stats) => {
if (err) throw new gutil.PluginError('webpack', err)
gutil.log('Please allow `http://localhost:3000` connections in Google Chrome')
gutil.log('and load unpacked extensions with `./dev` folder. (see https://developer.chrome.com/extensions/getstarted#unpacked)')
gutil.log('Please load the unpacked extension with `./dev` folder.\n (see https://developer.chrome.com/extensions/getstarted#unpacked)')
}), {
publicPath: myConfig.output.publicPath,
stats: {colors: true},
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "ipfs-chrome-station",
"version": "0.0.1",
"description": "Chrome extension that let's have a look at your IPFS node stats",
"version": "0.0.2",
"description": "Chrome extension that let's you access IPFS urls seamlessly from your local IPFS node, and take a look at its stats.",
"scripts": {
"lint": "standard --verbose | snazzy",
"dev": "gulp",
Expand All @@ -11,7 +11,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/xicombd/ipfs-pocket"
"url": "https://github.com/xicombd/ipfs-chrome-station"
},
"homepage": "https://github.com/xicombd/ipfs-chrome-station",
"author": "Francisco Dias <[email protected]>",
Expand Down

0 comments on commit f2ad43e

Please sign in to comment.