Git Product home page Git Product logo

resin-electronjs's Introduction

resin.io + electronJS = love

resin-electronjs

a boilerplate for developing kiosks, digital signage or other human-machine interaction projects based on ElectronJS and resin.io

This is the very basic layer on which snappin.io builds its touch-enabled apps.

PRE-REQUISITES

this application is meant to be deployed to RaspberryPi2 devices via resin.io.

At least 64MB of GPU-dedicated RAM is required. You can achieve that locally following these instructions (only the first parameter gpu_mem=64 is required) or, as we strongly suggest, set it remotely with Resin's Advanced Boot Configuration feature.

WHY THIS TEMPLATE

Achieving kinda-smooth desktop application display on a raspberrypi is hard. This project aims to provide a quickstart template.

WHY FLUXBOX

We did a lot of researches and tests with several window managers. Fluxbox ended up being the most balanced between minimum footprint and features

URL LAUNCHER config via ENV VARS

simply set these environment varables in your app via the resin dashboard to configure the behaviour of your devices

  • URL_LAUNCHER_URL string - the URL to be loaded. use file:///app/app/index.html to load a local electronJS (or any website) app - defaults to http://resin.io
  • URL_LAUNCHER_NODE bool (converted from string) - whether or not enable nodejs - defaults to false
  • URL_LAUNCHER_KIOSK bool (converted from string) - whether or not enter KIOSK mode - defaults to true
  • URL_LAUNCHER_TITLE string - the title of the window. Seen only with URL_LAUNCHER_FRAME=true - defaults to RESIN.IO
  • URL_LAUNCHER_FRAME bool (converted from string) - set to "true" to display the window frame. Seen only with URL_LAUNCHER_KIOSK=false - defaults to false
  • URL_LAUNCHER_CONSOLE bool (converted from string) - set to "true" to display the debug console - defaults to false
  • URL_LAUNCHER_WIDTH int (converted from string) - - defaults to 1920
  • URL_LAUNCHER_HEIGHT int (converted from string) - - defaults to 1080
  • URL_LAUNCHER_TOUCH bool (converted from string) - enables touch events if your device supports them - defaults to false
  • URL_LAUNCHER_TOUCH_SIMULATE bool (converted from string) - simulates touch events - might be useful for touchscreen with partial driver support - be aware this could be a performance hog - defaults to false

resin-electronjs's People

Contributors

curcuz avatar

Watchers

James Cloos avatar Daniel Mahon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.