From e18a7bfb6875121e794395aa227f3a9d9bd1508e Mon Sep 17 00:00:00 2001
From: Ivan Alglave <64541968+hihubbIe@users.noreply.github.com>
Date: Thu, 17 Nov 2022 09:04:25 +0100
Subject: [PATCH] Update README.md

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f03c921..ea0bbb5 100644
--- a/README.md
+++ b/README.md
@@ -26,13 +26,33 @@
 
 **IntershipManager** - The whole lifecycle of internship agreements in one app !
 
+This is the **REST API** connecting to the InternshipManager front end application to manage **CRUD** operations.
+
 ## Installation
 
 ```bash
 $ npm install
 ```
 
-In `/src/config/` create a file called `config.json` and copy the content of `config.template.json` in it. Change the values such as the server port to match your needs.
+In `/src/config/`, make a copy of the file `config.template.json` and rename it to `config.json`. 
+Set the following field :
+```json
+"server": {
+  "port": 3001
+},
+```
+You may replace `3001` by any port you wish to run the application on.
+
+### Initiating the database
+
+This server uses [Mongodb](https://www.mongodb.com/) for persistent data storage. To initiate the database, you must have an instance of mongo running. You may use the dockerfile located in `docker/` at the root of the project and run the command `docker-compose up -d` to create and run a mongo instance as a background task.
+In the `src/config/config.json`, set the following field :
+```json
+"mongodb": {
+  "uri": "mongodb://localhost:27017/internship-manager"
+}
+```
+In the event you wish to run mongo on another port or use another collection, make sure to update the **uri** in the config file.
 
 ## Running the app
 
-- 
GitLab