Skip to content

Commit

Permalink
readme, yarn and package
Browse files Browse the repository at this point in the history
  • Loading branch information
@nucleardreamer
nucleardreamer committed Mar 16, 2017
1 parent 21bc032 commit db92430
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 44 deletions.
10 changes: 9 additions & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "oak",
"productName": "Oak",
"version": "1.1.0",
"description": "connect with peripherials ontop of oak hardware",
"description": "A very opinionated kiosk framework based on Electron",
"engines": {
"node": "6.5.0"
},
Expand Down Expand Up @@ -50,6 +50,14 @@
"tap-difflet": "~0.4.0",
"tape": "~4.6.0"
},
"keywords": [
"oak",
"IoT",
"oak",
"kiosk",
"electron",
"docker"
],
"standard": {
"ignore": [
"*/tmp/"
Expand Down
21 changes: 12 additions & 9 deletions readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# oak
# Oak
[![release](https://img.shields.io/badge/release-v1.0.0-green.svg)](https://github.com/OakLabsInc/oak/releases/tag/1.0.0)
[![node](https://img.shields.io/badge/node-v6.5.0-green.svg)](https://github.com/nodejs/node/releases/tag/v6.5.0)
[![electron](https://img.shields.io/badge/electron-v1.4.15-green.svg)](https://github.com/electron/electron/releases/tag/v1.4.15)
Expand All @@ -7,15 +7,15 @@

A very opinionated kiosk UI application based on [electron](http://electron.atom.io).

## Rationale
# Rationale
Most of the `electron` project if focused around desktop application development, which is great! But when you are dealing with public computing (ATM machines, airline ticketing, movie theater ticket vendors, etc), you don't really need all the features a traditional desktop application requires.
The job of the `oak` module is to give a really easy way to make a kiosk application with modern web technology, so that it's repeatable, scalable, and easy to rapidly prototype for production.

## Getting Started
# Getting Started

`oak` only requires a couple things to get up and running: A URL, and an `index.js` file.

### index.js
## index.js
The most minimal example, this will launch a fullscreen app, injecting the `oak` object into the client side:
```
const oak = require('oak')
Expand All @@ -39,7 +39,7 @@ url: 'file://' + join(__dirname, 'index.html')
// load your own webserver
url: 'http://localhost:8080'
```
### Options
## Options
Most of the `oak.load()` options are wrapping electron.js `BrowserWindow` options, but some are specific to our kiosk use-case.
```
// chrome launch flags to set while starting the window
Expand Down Expand Up @@ -101,7 +101,10 @@ If you want to develop and test quickly, you just need to have `oak` installed l

This will not give you a lot of the advantages of a dockerized application however. It's great for rapidly developing locally, but for a production usecase you will want to follow the steps below.

### I don't always test my code, but when I do...
# Examples
* [`oak-examples`](https://github.com/OakLabsInc/oak-examples)

# I don't always test my code, but when I do...

We use docker containers for all our production deployments. To get started, you will need to have Docker installed. You can install docker from their [website](https://www.docker.com/products/docker), or on Linux systems, run this script:

Expand All @@ -113,7 +116,7 @@ We use docker containers for all our production deployments. To get started, you

You will also need an X server running (`xorg`). If you are on OSX, go ahead and follow the steps below to get setup.

### On Linux
## On Linux
This example is for debian based systems, you can accomplish the same by getting `docker` and `docker-compose` running yourself.

1. Install `python-setuptools`
Expand Down Expand Up @@ -142,7 +145,7 @@ This example is for debian based systems, you can accomplish the same by getting
xhost -
```

### On OSX
## On OSX
I'm not going to lie... this is a pain in the ass. OSX doesn't have `xorg` or a build in X server by default. You are going to be using `socat` to proxy Xquartz via TCP so that you can use your IP address the docker container. It may be easier to start up a VM running ubuntu or debian.

1. Install [homebrew](https://brew.sh/)
Expand Down Expand Up @@ -196,7 +199,7 @@ I'm not going to lie... this is a pain in the ass. OSX doesn't have `xorg` or a
8. In your `oak` directory, run `docker-compose -f docker-compse.osx.yml up`
### On Windows
## On Windows
Sorry but you are a little on your own as far as an X server goes! In the future we may update this readme to provide info for developing on Windows. In the mean time... [Cygwin](https://www.cygwin.com/)?
Expand Down
58 changes: 24 additions & 34 deletions yarn.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,13 +240,7 @@ binary@^0.3.0:
buffers "~0.1.1"
chainsaw "~0.1.0"

bl@^1.0.0:
version "1.2.0"
resolved "https://registry.yarnpkg.com/bl/-/bl-1.2.0.tgz#1397e7ec42c5f5dc387470c500e34a9f6be9ea98"
dependencies:
readable-stream "^2.0.5"

bl@~1.1.2:
bl@^1.0.0, bl@~1.1.2:
version "1.1.2"
resolved "https://registry.yarnpkg.com/bl/-/bl-1.1.2.tgz#fdca871a99713aa00d19e3bbba41c44787a65398"
dependencies:
Expand Down Expand Up @@ -1513,7 +1507,7 @@ got@^6.7.1:
unzip-response "^2.0.1"
url-parse-lax "^1.0.0"

graceful-fs@^4.1.11, graceful-fs@^4.1.2, graceful-fs@^4.1.3, graceful-fs@^4.1.6, graceful-fs@^4.1.9, graceful-fs@~4.1.9:
graceful-fs@^4.1.2, graceful-fs@^4.1.3, graceful-fs@^4.1.6, graceful-fs@^4.1.9, graceful-fs@~4.1.9:
version "4.1.11"
resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.1.11.tgz#0e8bdfe4d1ddb8854d64e04ea7c00e2a026e5658"

Expand Down Expand Up @@ -1883,14 +1877,14 @@ js-tokens@^3.0.0:
version "3.0.1"
resolved "https://registry.yarnpkg.com/js-tokens/-/js-tokens-3.0.1.tgz#08e9f132484a2c45a30907e9dc4d5567b7f114d7"

[email protected], [email protected], js-yaml@^3.0.2, js-yaml@^3.3.0:
[email protected]:
version "3.6.1"
resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.6.1.tgz#6e5fe67d8b205ce4d22fad05b7781e8dadcc4b30"
dependencies:
argparse "^1.0.7"
esprima "^2.6.0"

js-yaml@^3.5.1, js-yaml@^3.8.1:
js-yaml@3.x, js-yaml@^3.0.2, js-yaml@^3.3.0, js-yaml@^3.5.1, js-yaml@^3.8.1:
version "3.8.2"
resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.8.2.tgz#02d3e2c0f6beab20248d412c352203827d786721"
dependencies:
Expand Down Expand Up @@ -2192,13 +2186,13 @@ minimist@^0.2.0:
version "0.2.0"
resolved "https://registry.yarnpkg.com/minimist/-/minimist-0.2.0.tgz#4dffe525dae2b864c66c2e23c6271d7afdecefce"

[email protected], [email protected], mkdirp@^0.5.0, mkdirp@~0.5.0:
[email protected]:
version "0.5.0"
resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.0.tgz#1d73076a6df986cd9344e15e71fcc05a4c9abf12"
dependencies:
minimist "0.0.8"

"mkdirp@>=0.5 0", mkdirp@^0.5.1, mkdirp@~0.5.1:
[email protected], "mkdirp@>=0.5 0", mkdirp@^0.5.0, mkdirp@^0.5.1, mkdirp@~0.5.0, mkdirp@~0.5.1:
version "0.5.1"
resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-0.5.1.tgz#30057438eac6cf7f8c4767f38648d6697d75c903"
dependencies:
Expand Down Expand Up @@ -2232,10 +2226,14 @@ mustache@^2.0.0:
version "2.3.0"
resolved "https://registry.yarnpkg.com/mustache/-/mustache-2.3.0.tgz#4028f7778b17708a489930a6e52ac3bca0da41d0"

[email protected], mute-stream@~0.0.4:
[email protected]:
version "0.0.5"
resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-0.0.5.tgz#8fbfabb0a98a253d3184331f9e8deb7372fac6c0"

mute-stream@~0.0.4:
version "0.0.7"
resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-0.0.7.tgz#3075ce93bc21b8fab43e1bc4da7e8115ed1e7bab"

nan@^2.0.0:
version "2.5.1"
resolved "https://registry.yarnpkg.com/nan/-/nan-2.5.1.tgz#d5b01691253326a97a2bbee9e61c55d8d60351e2"
Expand Down Expand Up @@ -2858,9 +2856,9 @@ read@1, read@~1.0.1, read@~1.0.7:
dependencies:
mute-stream "~0.0.4"

"readable-stream@1 || 2", "readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.0.5, readable-stream@^2.1.5, readable-stream@^2.2.2:
version "2.2.5"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.2.5.tgz#a0b187304e05bab01a4ce2b4cc9c607d5aa1d606"
"readable-stream@1 || 2", readable-stream@^2.0.1, readable-stream@^2.0.2, readable-stream@^2.1.5, readable-stream@~2.1.5:
version "2.1.5"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.1.5.tgz#66fa8b720e1438b364681f2ad1a63c618448c9d0"
dependencies:
buffer-shims "^1.0.0"
core-util-is "~1.0.0"
Expand All @@ -2871,8 +2869,8 @@ read@1, read@~1.0.1, read@~1.0.7:
util-deprecate "~1.0.1"

[email protected], readable-stream@^1.1.8, readable-stream@~1.1.11, readable-stream@~1.1.9:
version "1.1.14"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.1.14.tgz#7cf4c54ef648e3813084c636dd2079e166c081d9"
version "1.1.13"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.1.13.tgz#f6eef764f514c89e2b9e23146a75ba106756d23e"
dependencies:
core-util-is "~1.0.0"
inherits "~2.0.1"
Expand All @@ -2888,22 +2886,22 @@ [email protected], readable-stream@^1.1.8, readable-stream@~1.1.11, readable-s
isarray "0.0.1"
string_decoder "~0.10.x"

readable-stream@~2.0.0, readable-stream@~2.0.5:
version "2.0.6"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.0.6.tgz#8f90341e68a53ccc928788dacfcd11b36eb9b78e"
"readable-stream@^2.0.0 || ^1.1.13", readable-stream@^2.0.5, readable-stream@^2.2.2:
version "2.2.5"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.2.5.tgz#a0b187304e05bab01a4ce2b4cc9c607d5aa1d606"
dependencies:
buffer-shims "^1.0.0"
core-util-is "~1.0.0"
inherits "~2.0.1"
isarray "~1.0.0"
process-nextick-args "~1.0.6"
string_decoder "~0.10.x"
util-deprecate "~1.0.1"

readable-stream@~2.1.5:
version "2.1.5"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.1.5.tgz#66fa8b720e1438b364681f2ad1a63c618448c9d0"
readable-stream@~2.0.0, readable-stream@~2.0.5:
version "2.0.6"
resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.0.6.tgz#8f90341e68a53ccc928788dacfcd11b36eb9b78e"
dependencies:
buffer-shims "^1.0.0"
core-util-is "~1.0.0"
inherits "~2.0.1"
isarray "~1.0.0"
Expand Down Expand Up @@ -3744,15 +3742,7 @@ wrappy@1, wrappy@~1.0.2:
version "1.0.2"
resolved "https://registry.yarnpkg.com/wrappy/-/wrappy-1.0.2.tgz#b5243d8f3ec1aa35f1364605bc0d1036e30ab69f"

write-file-atomic@^1.1.2:
version "1.3.1"
resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-1.3.1.tgz#7d45ba32316328dd1ec7d90f60ebc0d845bb759a"
dependencies:
graceful-fs "^4.1.11"
imurmurhash "^0.1.4"
slide "^1.1.5"

write-file-atomic@~1.2.0:
write-file-atomic@^1.1.2, write-file-atomic@~1.2.0:
version "1.2.0"
resolved "https://registry.yarnpkg.com/write-file-atomic/-/write-file-atomic-1.2.0.tgz#14c66d4e4cb3ca0565c28cf3b7a6f3e4d5938fab"
dependencies:
Expand Down

0 comments on commit db92430

Please sign in to comment.