structure.md

Project structure

This repository contains the code needed for the node process (Electron main), the frontend (Electron renderer), the extension api and documentation.

The file tree looks like the following:

bridge
  |- api      # The plugin api, shared between processes
      |- browser    # Browser specific code
      |- node       # Node specific code
  |- app      # Frontend code
      |- assets     # Bundled assets
      |- components # React components
      |- hooks      # React hooks
      |- utils      # Utility files
      |- views      # Views
  |- docs     # Documentation
  |- examples # Plugin examples
  |- lib      # Node/backend
  |- media    # Static media for the documentation
  |- plugins  # Bundled plugins
  |- public   # Static files served by the web server
  |- shared   # Code shared between processes
  |- scripts  # Helper scripts used by the build process e.t.c. 

  These are created during the build process:
  
  |- dist     # Bundled js and css files, webpack output
  |- bin      # The built electron app