Skip to content

Commit

Permalink
Upd: Added step to update server configuration file
Browse files Browse the repository at this point in the history
  • Loading branch information
lalc authored and georgepadayatti committed Oct 31, 2023
1 parent 690e19c commit ad15e15
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,15 @@ The key deliverables of the project are as given. The table summarises the relea

## Instructions to run

Prerequisite: Docker is up and running in your server

1. Clone this repository to your local server using `git clone`
2. Checkout the latest release or any release available that you wish to run. E.g `git checkout tags/2023.10.4`
3. Execute `make setup`. This sets up the necessary dependencies and configurations for running Consent BB API server instance.
4. Execute `make build`. The compiles and assembles source code into executable files or libraries, following the instructions specified in the Makefile of Consent BB API server instance.
5. Execute `make run`. This executes a predefined set of instructions in the Makefile to launch or run the compiled Consent BB API server instance.
Prerequisites:
1. Docker is up and running in your server
2. The configuration file is updated for setting up default parameters for the instance such as organisation details, admin access security etc. This can be changed later as well.

3. Clone this repository to your local server using `git clone`
4. Checkout the latest release or any release available that you wish to run. E.g `git checkout tags/2023.10.4`
5. Execute `make setup`. This sets up the necessary dependencies and configurations for running Consent BB API server instance.
6. Execute `make build`. The compiles and assembles source code into executable files or libraries, following the instructions specified in the Makefile of Consent BB API server instance.
7. Execute `make run`. This executes a predefined set of instructions in the Makefile to launch or run the compiled Consent BB API server instance.

The server is up and running now locally at: "https://api.bb-consent.dev/v2". You can use openAPIs or the admin dashboard to interact with the Consent BB server instance.

Expand Down

0 comments on commit ad15e15

Please sign in to comment.