Skip to content

Code Organization

Jump to bottom
Paul Maréchal edited this page Sep 16, 2021 · 8 revisions

The code is fully implemented in TypeScript. Within the top level folders, that indicate what the contained code is about, we separate between the following platforms:

  • common/*: Source code that only requires basic JavaScript APIs and run in all the other target environments.
  • browser/*: Source code that requires the browser APIs like access to the DOM.
    • May use code from: common.
  • node/*: Source code that requires nodejs APIs.
    • May use code from: common.
  • electron-node/*: Electron specific source code that requires nodejs APIs.
    • May use code from: common, node.
  • electron-browser/*: Source code that requires the Electron renderer-process APIs.
    • May use code from: common, browser.
  • electron-main/*: Source code that requires the Electron main-process APIs.
    • May use code from: electron-node, common, node.

Project Management

Documentation

Clone this wiki locally