diff options
Diffstat (limited to 'docs/architecture/NBI_R1_Developer_Guide.rst')
| -rw-r--r-- | docs/architecture/NBI_R1_Developer_Guide.rst | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/architecture/NBI_R1_Developer_Guide.rst b/docs/architecture/NBI_R1_Developer_Guide.rst index 1d17665..e855fea 100644 --- a/docs/architecture/NBI_R1_Developer_Guide.rst +++ b/docs/architecture/NBI_R1_Developer_Guide.rst @@ -53,12 +53,20 @@ Or through a terminal, ensure that your maven installation is works and run *mvn **Docker** -in progress ... +Requirements: `Docker engine <https://docs.docker.com/engine/>`_ and `docker-compose <https://docs.docker.com/compose/>`_. +To start the application: + 1. Generate the application .jar file: `$ mvn clean package` + 2. Configure the **.env** file + 3. Start the *MariaDB* and *MongoDB* services: `$ docker-compose up -d mongo mariadb` + 4. Build and start the *NBI* service: `$ docker-compose up --build -d nbi` + +You can view the log output of the application with the following command: + +`$ docker-compose logs -f nbi` **Testing** When the app is running, you can access the API at http://yourhostname:8080/nbi/api/v1/ and fill the url with the name of the resources you asking for (/serviceSpecification, /service, /serviceOrder or /status) You can run a test by using `VisualStudio RestClient plugin <https://github.com/Huachao/vscode-restclient>`_ See the *restclient* package at root level to find *.vscode/settings.json* configuration file and */json/* package with samples requests that can be run. You can also trigger these endpoints with any RESTful client or automation framework. - |