Running locally

Running the example apps locally

Follow these steps to run the example apps locally.

1. Clone the example apps repo, https://github.com/UnbloktTechnology/ComPilot-Examples.

2. Copy example-apps/.env.local to example-apps/.env.

3. Edit example-apps/.env as described in the following table.

   Variable	Description
   NODE_ENV	Set to production
   NEXT_PUBLIC_ENVIRONMENT	Set to prod
   COMPILOT_API_KEY_DEFI_RULE_ENGINE	ComPilot API key for the compliant Uniswap app
   COMPILOT_API_KEY_DEFI_OFFCHAIN_ZKP	ComPilot API key for the gated Uniswap app
   COMPILOT_API_KEY_BANK	ComPilot API key for the banking app
   COMPILOT_API_KEY_BANK_WEB3	ComPilot key for the Web3 banking app
   COMPILOT_API_KEY_KYC	ComPilot API key for the KYC app
   COMPILOT_API_KEY_BANK_SYGNUM_WEB3	ComPilot API key for the Sygnum Web3 app

   You can get the ComPilot API keys for your apps by following the instructions on Getting an API key. You need to set each of the API_KEY variables, even if you only want to use one of the example apps. If necessary, you can set them all to the same value.

   note

   For more information about these variables, see example-apps/src/env.mjs.

4. Run npm install in example-apps.

5. Run npm run dev in example-apps.

The example apps can now be accessed at http://localhost:3020.