Build executables and run manually
Last updated
Last updated
If you want to manually build every component with debug information, then build and run the services and packages in the following sequence: Interfaces, Logger Helper, Message Broker, Logger Service, Auth Service, IPFS, Guardian Service, UI Service, and lastly, the MRV Sender Service. See below for commands.
,
Install, configure and start all the prerequisites, then build and start each component.
for each of the services create the file ./<service_name>/.env
to do this copy, past and rename the file ./<service_name>/.env.template
For example:
in ./guardian-service/.env
:
If need to configure OVERRIDE uncomment the variable in file ./guardian-service/.env
:
configure the file ./<service_name>/configs/.env.<service>.<GUARDIAN_ENV>
file: to do this copy, past and rename the file ./<service_name>/.env.<service>.template
following previous example:
in ./guardian-service/configs/.env.guardian.develop
:
Setting up Chat GPT API KEY to enable AI Search and Guided Search:
For setting up AI and Guided Search, we need to set OPENAI_API_KEY variable in ./ai-service/configs/.env*
files.
NOTE: Once you start each service, please wait for the initialization process to be completed.**
Clone the repo
Install dependencies
Build @guardian/interfaces package
Build @guardian/common package
Build and start logger-service service
To build the service:
Configure the service as previously described. Do not need special variables configuration.
To start the service:
Build and start auth-service service
To build the service:
Configure the service as previously described. Do not need special variables configuration.
To start the service:
Build and start policy-service service
To build the service:
Configure the service as previously described. Do not need special variables configuration.
To start the service:
Build and start worker-service service To build the service:
Configure the service as previously described. Update IPFS_STORAGE_API_KEY value in ./worker-service/configs/.env.worker
file.
To start the service:
Build and start notification-service service
To build the service:
Yarn:
Npm:
Configure the service as previously described. Update OPERATOR_ID and OPERATOR_KEY values in ./guardian-service/configs/.env.worker
file as in the example above.
Yarn:
Npm:
Build and start guardian-service service
To build the service:
Configure the service as previously described. Update OPERATOR_ID and OPERATOR_KEY values in ./guardian-service/configs/.env.worker
file as in the example above.
Build and start api-gateway service
To build the service:
Configure the service as previously described. Do not need special variables configuration.
From the mrv-sender folder
To build the service:
Configure the service as previously described. Do not need special variables configuration.
From the ai-service folder
To build the service:
Yarn:
Npm:
Configure the service as previously described. Do not need special configuration variables.
Yarn:
Npm:
From the frontend folder
To build the service:
Note: For correct start of auth-service it is necessary to fill in JWT_PRIVATE_KEY and JWT_PUBLIC_KEY, which are RSA key pair. You can generate it in any convenient way, for example, using this service .
To start the service (found on ):
To start the service (found on ):
To start the service (found on ):
To start the service (found on ):
To start the service (found on )
Browse to and complete the setup. To get more info, please check: