Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 1.71 KB

developing.md

File metadata and controls

47 lines (36 loc) · 1.71 KB
Raw

To use this as a developer:

  • Clone it from git.

  • You will need to have node.js install.

    cd Bounce npm install npm start

  • serialport usually needs a rebuild - to get this:

    • npm install -g node-gyp
    • On windows: npm install --global --production windows-build-tools
    • On Ubuntu: sudo apt-get install build-essential
    • Then do "npm run-script rebuil"

  • To create a package

    npm run-script package

Note on Style

Where you can, please stick to https://google.github.io/styleguide/javascriptguide.xml and https://google.github.io/styleguide/htmlcssguide.xml.

Test using the Jasmine test specs - yes there are gaps.

UI modifications

Use jquery where possible - it is often simpler than the closure equivalent. Closure is what blockly is based upon - but can lead to very heavyweight code compared to the jquery alternative.

Changing libraries

If you need to change the goog dependancies, or blockly version this is a bit trickier. You will need standard gnu loadout + a jre. Use GOW on windows.

Use update_libs.sh - and then you will need to commit the compressed output.

Quick Overview of App components:

  • BounceConfig - Manage/update and store user config preferences - mostly related to serial.
  • GeneratedCode - Manages the generated code tab
  • Nodemcu - Managed communication with the NodeJS via Serial.
  • OutputConsole - Component for the output tab showing serial output and allowing a user input.
  • BlocklyManager - This manages the blockly workspace - some of the operations performed on it.
  • BounceUI - This ties the UI into the app functions.
  • blockly-nodemcu - Blockly (the language) with Lua generation.
  • CustomNodeBlocks - Additional blocks specific to the NodeMCU system.