From 33383b44bcba3c421873a1b274fb1f57ac147fc4 Mon Sep 17 00:00:00 2001 From: Joel Robles Date: Tue, 19 Sep 2023 12:57:53 +0200 Subject: [PATCH] Updating Readme (#298) * Updatin Readme Updating to readme to show how to updated the database. see https://github.com/digital-sustainability/oss-github-benchmark/issues/297 * typos * Updating Readme Specified where to find credentials and which database to use * Updating DB in readme. Updated Database in Readme --------- Co-authored-by: Joel --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5da69354..144b04fd 100644 --- a/README.md +++ b/README.md @@ -41,4 +41,15 @@ The crawler will just update the data, starting with the oldest timestamp. ## Database Stucture -![System Diagram](/assets/images/DBStructure.png) \ No newline at end of file +![System Diagram](/assets/images/DBStructure.png) + +## Update Institutions + +Once someone has updated the github_repos.json file and the pull request was merged, the new or updated insitution must be added to the database. + +This can be done in 4 easy steps: + +1. Pull Repository +2. Connect to DB with MongoDB Compass. The Credentials can be found in Keepass +3. Choose the **production** DB and then todoInstitution collection. +4. Press **Add Data -> Import file** and choose github_repos.json. Keep in mind that *Stop on errors* needs to be unchecked. Then just click *Import*. \ No newline at end of file