From 8f9b91a39ccbd8d2a72249f3937df23b08d3f8f4 Mon Sep 17 00:00:00 2001 From: Mahdi Sellami Date: Fri, 3 Jul 2020 17:31:03 +0200 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 41138bf..4c5f7d3 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,23 @@ Through a RESTful API as interface, a public service provider module can be easi ### Overview This server was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [OpenAPI-Spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate a server stub. +### Install and configure MongoDB + +This server is using MongoDB. Please refer to [mongoDB installation guide](https://docs.mongodb.com/manual/installation/#mongodb-community-edition-installation-tutorials) to install the Community Edition. + +If you are not hosting mongoDB in its default adress, please update the host value in '/config/default.json'. For example: + +``` +{ + "dbConfig": { + "host": "YourMongoDbHostAdress" + }, + "serverConfig": { + "port": 8080 + } +} +``` + #### Running the server To run the server, run: -- GitLab