Skip to content

Core

This guide explains how to set up your development environment for working on the client codebase.

Warning

This documentation assumes that you have already set up a Bip development instance, and that your development directories are following the recommended structure.

Environment variables

When running your script, for testing your changes on the core for instance, specify the following environment variables:

  • BIP_CONFIG: Bip configuration file (example: /path/to/bip/config/config.yml)
  • BIP_AUTH: Bip authentication file (example: /path/to/bip/config/auth.yml)
  • BIP_DATABASE_PASSWORD: Neo4j password (example: your-database-password
  • BIP_CONTENT: Bip content repository (example: /path/to/bip/content)

If your development machine has a production Bip client installed, you must also override the following environment variables, in order to avoid conflicting with the production instance:

  • BIP_PATH: Root of the Bip ecosystem (example: path/to/the/parent/folder/of/your/bip/repo)
  • BIP_PYTHON: Python virtual environment (example: path/to/the/root/of/the/python_venv)

If you are working in a hosted context, you must also specify the path to the Hosted Python venv:

  • BIP_PYTHON_HOST: Host Python venv (example: C:\Users\corentin\Documents\Code\.venvs\host)

Optionally, if you are working with the updating API (mink.update), you might find those overrides come in handy:

  • BIP_COMPATIBILITY_VERSION: If you need to override the server config's compatibility_version (example: 4.0.0)
  • BIP_CHECK_UPDATES: If you need to disable the updates checking at initialization. (example: false)
  • BIP_REFRESH_CONTENT: If you need to disable the content automatic update at initialization (example: false)
  • BIP_DEBUG_UPDATE_TARGET: test (example: C:\Users\corentin\AppData\Local\Blink)

Tip

For more information about environment variables, check this documentation.

Guidelines

Make sure you follow the contribution guidelines.