summaryrefslogtreecommitdiffstats
path: root/docs/installation
diff options
context:
space:
mode:
authorRene Robert <rene.robert@orange.com>2018-04-23 14:15:02 +0000
committerRene Robert <rene.robert@orange.com>2018-04-23 14:15:02 +0000
commitf7e11655a83b6d6c79355e52960e9c8903ff565c (patch)
treec2d9036fb4bebce9da800939c2bb1159fc008052 /docs/installation
parent75bb5d29fb3d083b7f6df56a6953da55647de0ca (diff)
add info in doc
Issue-ID: EXTAPI-74 Change-Id: Iebea5ef0fa56ae0c9c11babdc108acc9b3ee0e40 Signed-off-by: Rene Robert <rene.robert@orange.com>
Diffstat (limited to 'docs/installation')
-rw-r--r--docs/installation/installation.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/installation/installation.rst b/docs/installation/installation.rst
index a6ab912..bb392d3 100644
--- a/docs/installation/installation.rst
+++ b/docs/installation/installation.rst
@@ -7,9 +7,39 @@ Installation
============
+
Environment
-----------
+**Locally**
+
+Ensure that you have a MongoDB and MariaDB instance running and properly configured in *application.properties* file.
+Run *Application.java* class in your favorite IDE
+
+Or through a terminal, ensure that your maven installation is works and run *mvn spring-boot:run* command to start the appication.
+
+
+**Docker**
+
+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`
+
Steps
-----
+
+**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.
+