===== Registry  =====
The **registry** is part of the BeuthBot microservice system.Here the evaluated messages arrive and it is decided which service should be used. The reply from the service is forwarded to the gateway.


==== Table Of Content ====
   - [[wiki:software:beuthbot:registry#registry|Registry]]
   - [[wiki:software:beuthbot:registry#table of content|Table Of Content]]
   - [[wiki:software:beuthbot:registry#getting_started|Getting Started]]
    - [[wiki:software:beuthbot:registry#prerequisites|Prerequisites]]
    - [[wiki:software:beuthbot:registry#cloning|Cloning]]
    - [[wiki:software:beuthbot:registry#installing|Installing]]
   - [[wiki:software:beuthbot:registry#overview|Overview]]
   - [[wiki:software:beuthbot:registry#structure|Structure]]
   - [[wiki:software:beuthbot:registry#functionalities|Functionalities]]
   - [[wiki:software:beuthbot:registry#further_development|Further Development]]
   - [[wiki:software:beuthbot:registry#further_reading|Further Reading]]
   - [[wiki:software:beuthbot:registry#built_with|Built With]]
   - [[wiki:software:beuthbot:registry#versioning|Versioning]]
   - [[wiki:software:beuthbot:registry#authors|Authors]]

==== Getting Started ====


=== Prerequisites ===

- [[https://nodejs.org/en/|node.js]] \\ 
- [[https://expressjs.com/|express.js]]\\
- [[https://www.npmjs.com/package/axios| axios]]

=== Cloning ===

Get the source code by cloning its repository via https: [[https://github.com/beuthbot/registry|Registry]]


=== Installing ===

After cloning the repository, you will need to make sure that you have node and npm installed on your working system. To check if you already have node installed, try

''node --version''

Same for checking if npm is installed, just with npm instead of the node command

''npm --version''

If you don't have node or npm installed, download the Softare via the links provided in [[wiki:software:beuthbot:registry#prerequisites|Prerequisites]] or search for them via your preferred search engine.

After that install all necessesary dependencies

''npm install''

Now you can start the local development server to play around with the API and make your calls

''npm run dev''

This will fire up a development server that listens on port 3000.



==== Overview ====
The registry was built as a regular machine for the chatbot. Here it is decided which service is responsible for delivering the answer to the user. The decision is made on the Intent of the NLU unit.
==== Structure ====
The registry consists of two files of a JavaScript file which reflects the service. And a Json file which contains the configuration of the available services. Here each intent is assigned a corresponding service interface. 
==== Functionalities ====

The registry forwards the incoming requests as a request to the various services and waits for their response before forwarding them to the requester. 




==== Further Development ====
To be able to offer further services the corresponding intent only needs to be included in the json file with an interface. Later it would be possible to extend this service with a better self-learning rule engine. 



==== Further Reading ====
-[[https://www.drools.org/|Drools]]




==== Built With ====

- [[https://nodejs.org/en/|Node.js]]\\
- [[https://expressjs.com/|Express.js]]\\
- [[https://www.npmjs.com/package/axios|Axios]]\\
- [[https://www.npmjs.com/package/body-parser|Body-Parser]]\\


==== Versioning ====

We use [[https://github.com/|GitHub]] for versioning.

==== Authors ====

 **Timo Bruns** - //Initial work// - [[https://github.com/Tarry93|GitHub]] \\
\\
 **Christopher Lehmann** - //Initial work// - [[https://github.com/Chr1ssy|GitHub]]\\

See also the list of [[https://github.com/beuthbot/registry/graphs/contributors|contributors]] who participated in this project.
<WRAP pagebreak></WRAP>