Skip to content

Structure

When developing with/for Bip, multiple repositories are required, and it is recommended to organise them by replicating the structure generated by the installer on a regular user machine.

Warning

It is not mandatory but strongly encouraged.

  • bip/
    • client Bip client (Git repository).
    • apps/ Application plugins directory.
      • foo Developed application (Git repository).
      • ...
    • handlers/ Handler plugins directory.
      • bar Developed handler (Git repository).
      • ...
  • python Main Python 3.9 (venv).
  • hosted Host Python 3.9 (venv).
  • content Client content (Git repository).
  • local Non Git repositories.
    • config Configuration files directory.
      • dev/
        • config.yml
        • auth.yml
        • plugins.yml For BIP_DEBUG_PLUGIN_DATA, if used.
      • prod/
        • same as ../dev
    • scripts Testing scripts.
    • working Local working directory for dev cases.