Skip to content
This repository has been archived by the owner on Apr 9, 2020. It is now read-only.

Commit

Permalink
Add instructions to Read.me
Browse files Browse the repository at this point in the history
  • Loading branch information
rog committed Nov 28, 2016
1 parent 672cfbc commit b407846
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 19 deletions.
42 changes: 24 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,43 @@
# live.hyperfox.org
# [live.hyperfox.org](https://github.com/xiam/hyperfox-live)
> This is the source code of the [Hyperfox][1]'s [live visualization tool][2].
This is the source code of the [Hyperfox][1]'s [live visualization tool][2].

## Requisites

* ruby
* rubygems
* nodejs (I know, I know...)
* npm
* Node.js (>=6)
* npm (>=3)

## Initial setup

```
gem install compass
cd html
npm install
sudo npm install -g bower
sudo npm install -g grunt-cli
bower update
npm install grunt-contrib-compass --save-dev
```

## Development

```bash
# start a webpack server for development
# at http://localhost:3000
npm run start:development
```
cd html
grunt serve

## Build
See [electron-packager](https://github.com/electron-userland/electron-packager) for electron package requirements.

```bash
# create the webpack build in the `build` folder
npm run build
# create an electron package for all the platforms
npm run package
# create an electron package for osx
npm run package:osx
# create an electron package for windows
npm run package:win
# create an electron package for linux
npm run package:linux
```


# License (MIT)

> Copyright (c) 2014-2015 José Carlos Nieto, https://menteslibres.net/xiam
Expand Down
2 changes: 1 addition & 1 deletion server/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const app = express()
setup(app, {
outputPath: resolve(process.cwd(), 'build'),
publicPath: '/'
})<
})

// get the intended port number, use port 3000 if not provided
const port = argv.port || process.env.PORT || 3000
Expand Down

0 comments on commit b407846

Please sign in to comment.