🚀Merge v0.2-release into main (#124)

🚀Merge v0.2-release into main

package.json

@@ -1,33 +1,42 @@
 {
   "name": "repeatio",
-  "version": "0.1.0",
-  "description": "Repeatio is a program for practicing and memorizing tasks",
+  "version": "0.2.0",
+  "description": "Learn, repeat and memorize tasks with repeatio.",
   "author": "Niklas Fischer",
   "private": true,
   "main": "public/electron.js",
   "homepage": "./",
   "dependencies": {
-    "@electron/remote": "^1.2.1",
-    "@emotion/react": "^11.5.0",
-    "@emotion/styled": "^11.3.0",
-    "@mui/material": "^5.0.6",
-    "@react-hook/resize-observer": "^1.2.4",
-    "@testing-library/jest-dom": "^5.14.1",
-    "@testing-library/react": "^11.2.7",
+    "@babel/runtime": "^7.18.3",
+    "@electron/remote": "^2.0.8",
+    "@emotion/react": "^11.9.0",
+    "@emotion/styled": "^11.8.1",
+    "@mui/material": "^5.8.2",
+    "@react-hook/resize-observer": "^1.2.5",
+    "@testing-library/jest-dom": "^5.16.4",
+    "@testing-library/react": "^12.1.5",
     "@testing-library/user-event": "^12.8.3",
-    "concurrently": "^6.2.1",
+    "concurrently": "^7.2.1",
     "cross-env": "^7.0.3",
+    "d3-ease": "^3.0.1",
     "electron-devtools-installer": "^3.2.0",
     "electron-is-dev": "^2.0.0",
     "is-electron": "^2.2.1",
     "lodash": "^4.17.21",
     "react": "^17.0.2",
+    "react-circular-progressbar": "^2.0.4",
     "react-dom": "^17.0.2",
-    "react-icons": "^4.2.0",
-    "react-router-dom": "^5.3.0",
-    "react-scripts": "4.0.3",
-    "wait-on": "^6.0.0",
-    "web-vitals": "^1.1.2"
+    "react-icons": "^4.4.0",
+    "react-markdown": "^8.0.3",
+    "react-move": "^6.5.0",
+    "react-router-dom": "^5.3.3",
+    "react-scripts": "5.0.1",
+    "rehype-katex": "^6.0.2",
+    "rehype-raw": "^6.1.1",
+    "remark-gfm": "^3.0.1",
+    "remark-math": "^5.1.1",
+    "wait-on": "^6.0.1",
+    "web-vitals": "^2.1.4"
   },
   "build": {
     "appId": "repeatio",
@@ -93,7 +102,7 @@
     ]
   },
   "devDependencies": {
-    "electron": "^17.0.0",
-    "electron-builder": "^22.14.5"
+    "electron": "^17.4.7",
+    "electron-builder": "^22.14.13"
   }
 }

public/data.json

@@ -1,92 +1,150 @@
-[
   {
-    "id": "Test2",
-    "name": "Test from public",
+    "id": "types_1",
+    "name": "Question Types",
     "createdAt": "some UTC time",
-    "description": "Some description",
-    "questions" :
-    [
+    "description": "See what kind a questions can be used with repeatio",
+    "questions": [
       {
         "id": "qID-1",
-        "title": "This is a question provided by the public folder",
+        "title": "This question is of the type Multiple-Choice. Exactly _**one**_ correct answer must be selected. A circle in front of each option can help to identify this kind of question. How many options can be correct?",
         "points": 5,
         "type": "multiple-choice",
-        "questionTypeHelp": "Choose the correct answer.",
-        "answerOptions":
-        [
-          { "id": "option-1", "text": "Lorem ipsum dolor, sit amet consectetur adipisicing elit. Voluptas voluptatibus quibusdam magnam.", "isCorrect": true },
-          { "id": "option-2", "text": "Lorem ipsum dolor sit amet consectetur adipisicing.", "isCorrect": false },
+        "questionTypeHelp": "Please choose the correct answer.",
+        "answerOptions": [
+          {
+            "id": "option-1",
+            "text": "All options can be correct",
+            "isCorrect": false
+          },
+          {
+            "id": "option-2",
+            "text": "One or more options can be correct",
+            "isCorrect": false
+          },
           {
             "id": "option-3",
-            "text": "Lorem ipsum dolor, sit amet consectetur adipisicing elit. Expedita nemo unde blanditiis dolorem necessitatibus consequatur omnis, reiciendis doloremque recusandae? Soluta ex sit illum doloremque cum non sunt nesciunt, accusantium dolorem.",
+            "text": "No option can be correct",
             "isCorrect": false
+          },
+          {
+            "id": "option-4",
+            "text": "Exactly one option can be correct",
+            "isCorrect": true
           }
         ]
       },
       {
         "id": "qID-2",
-        "title": "This is a question provided by the public folder",
+        "title": "Multiple Response questions have _**at least one**_ correct answer. This type of question is represented by a square in front of each option. <br /> Please note that _**all**_ correct options must be selected, otherwise there will be no points awarded.<br /> How many options can be correct?",
         "points": 5,
         "type": "multiple-response",
-        "questionTypeHelp": "Choose the correct answer(s) please.",
-        "answerOptions":
-        [
-          { 
-            "id": 
-            "option-1", 
-            "text": "Lorem ipsum dolor, sit amet consectetur adipisicing elit. Voluptas voluptatibus quibusdam magnam.", 
-            "isCorrect": true 
+        "questionTypeHelp": "Please choose the correct answer(s).",
+        "answerOptions": [
+          {
+            "id": "option-1",
+            "text": "All options can be correct",
+            "isCorrect": true
           },
-          { 
-            "id": "option-2", 
-            "text": "Lorem ipsum dolor sit amet consectetur adipisicing.", 
-            "isCorrect": false 
+          {
+            "id": "option-2",
+            "text": "One or more options can be correct",
+            "isCorrect": true
           },
           {
             "id": "option-3",
-            "text": "Lorem ipsum dolor, sit amet consectetur adipisicing elit. Expedita nemo unde blanditiis dolorem necessitatibus consequatur omnis, reiciendis doloremque recusandae? Soluta ex sit illum doloremque cum non sunt nesciunt, accusantium dolorem.",
+            "text": "No option can be correct",
+            "isCorrect": false
+          },
+          {
+            "id": "option-4",
+            "text": "One option can be correct",
+            "isCorrect": true
+          },
+          {
+            "id": "option-5",
+            "text": "This question type is identical with Multiple-Choice questions",
+            "isCorrect": false
+          },
+          {
+            "id": "option-6",
+            "text": "Half points can be awarded if 50% of the options are correct",
             "isCorrect": false
           }
         ]
-      }, 
+      },
       {
         "id": "qID-3",
-        "title": "This is a question provided by the public folder",
+        "title": "This is a question of the type gap text. Each gap has to be filled with the correct word.<br /> Please note that spelling mistakes are _**not tolerated**_ but partial points are awarded for a correct gap.<br /> If different words are correct for one gap, you only need to input one but the correction will show all separated by a semicolon (;). The following text has three gaps that have to be filled.",
         "points": 5,
         "type": "gap-text",
         "questionTypeHelp": "Fill in the blanks.",
-        "answerOptions":
-        { 
-          "text": "[] two three. One [] three. One two [].", 
-          "correctGapValues" : 
-          [
-            ["One", "one"], 
-            ["two"], 
-            ["three"] 
+        "answerOptions": {
+          "text": "A gap text question can have multiple []. A [] separates the correct words for one gap. When answering a question the user has to use the correct spelling because spelling mistakes are [] tolerated.",
+          "correctGapValues": [
+            [
+              "gaps"
+            ],
+            [
+              "semicolon",
+              ";"
+            ],
+            [
+              "not"
+            ]
           ]
         }
       },
       {
         "id": "qID-4",
-        "title": "This is a question provided by the public folder",
+        "title": "This is a question of the type gap text with preselected values for each gap. Each gap is rated independently, meaning that part points are possible. Choose the correct values for each gap in the following text.",
+        "points": 5,
+        "type": "gap-text-dropdown",
+        "questionTypeHelp": "Fill in the blanks with the **correct** Values!",
+        "answerOptions": {
+          "text": "Possible values for each gap can be selected from a []-list. If the user answers 50% of the gaps correctly, he will be awarded [] of the points.",
+          "dropdowns": [
+            {
+              "id": "select-0",
+              "options": [
+                "Dropdown",
+                "Pickup",
+                "empty"
+              ],
+              "correct": "Dropdown"
+            },
+            {
+              "id": "select-1",
+              "options": [
+                "0%",
+                "25%",
+                "50%",
+                "75%",
+                "100%"
+              ],
+              "correct": "50%"
+            }
+          ]
+        }
+      },
+      {
+        "id": "qID-5",
+        "title": "This is a question of the type Extended Match. The values of the left side have to be connected to the values of the right side but not all values have to be connected. A value can be selected by clicking on the circle. Dragging is currently not supported.<br /> Please note that _**all**_ correct options must be connected, otherwise there will be no points awarded. Please connect the following values.",
         "points": 5,
         "type": "extended-match",
         "questionTypeHelp": "Connect the dots.",
-        "answerOptions":
-        {
-          "leftSide": 
-          [
-            { "id": "left-0", 
-              "text": "Hello" 
+        "answerOptions": {
+          "leftSide": [
+            {
+              "id": "left-0",
+              "text": "Hello"
             },
             {
               "id": "left-1",
               "text": "7+4"
             }
           ],
-          "rightSide":
-          [
-            { 
+          "rightSide": [
+            {
               "id": "right-0",
               "text": "World"
             },
@@ -99,13 +157,49 @@
               "text": "11"
             }
           ],
-          "correctMatches": 
-          [
-            {"left": "left-0", "right": "right-0"},
-            {"left": "left-1", "right": "right-2"}
+          "correctMatches": [
+            {
+              "left": "left-0",
+              "right": "right-0"
+            },
+            {
+              "left": "left-1",
+              "right": "right-2"
+            }
+          ]
+        }
+      },
+      {
+        "id": "qID-6",
+        "title": "Gap texts with and without preselected values can be combined with html tables to achieve this question.",
+        "points": 5,
+        "type": "gap-text-dropdown",
+        "questionTypeHelp": "Fill in the blanks by choosing the correct answer from the dropdown list!",
+        "answerOptions": {
+          "text": "<table><tr><th></th><th>Hamburg</th><th>München</th></tr><tr><td>Residents</td><td>[]</td><td>[]</td></tr></table>",
+          "dropdowns": [
+            {
+              "id": "select-0",
+              "options": [
+                "1.8 Mio",
+                "1.5 Mio",
+                "2.9 Mio",
+                "2 Tsd."
+              ],
+              "correct": "1.8 Mio"
+            },
+            {
+              "id": "select-1",
+              "options": [
+                "1.8 Mio",
+                "1.5 Mio",
+                "2.9 Mio",
+                "2 Tsd."
+              ],
+              "correct": "1.5 Mio"
+            }
           ]
         }
       }
     ]
-  }
-]
+  }

public/electron.js

@@ -16,6 +16,10 @@ function createWindow() {
       contextIsolation: true, // protect against prototype pollution
       enableRemoteModule: false, // turn off remote
       preload: path.join(__dirname, "preload.js"),
+      webSecurity: false, //!So markdown can load locale images
+      //!Change to this in the future https://stackoverflow.com/a/60251400/14602331
+      //https://www.electronjs.org/docs/latest/api/protocol
+      //https://stackoverflow.com/questions/8499633/how-to-display-base64-images-in-html
     },
   });
 

public/index.html

@@ -7,9 +7,9 @@
     <meta name="theme-color" content="#000000" />
     <meta
       name="description"
-      content="Web site created using create-react-app"
+      content="Practice and memorize task fast and efficiently with repeatio."
     />
-    <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
+    <!-- <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" /> -->
     <!--
       manifest.json provides metadata used when your web app is installed on a
       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/

public/manifest.json

@@ -1,25 +1,15 @@
 {
-  "short_name": "React App",
-  "name": "Create React App Sample",
+  "short_name": "Repeatio",
+  "name": "Repeatio",
   "icons": [
     {
       "src": "favicon.ico",
       "sizes": "64x64 32x32 24x24 16x16",
       "type": "image/x-icon"
-    },
-    {
-      "src": "logo192.png",
-      "type": "image/png",
-      "sizes": "192x192"
-    },
-    {
-      "src": "logo512.png",
-      "type": "image/png",
-      "sizes": "512x512"
     }
   ],
   "start_url": ".",
   "display": "standalone",
-  "theme_color": "#000000",
+  "theme_color": "#5A5AF5",
   "background_color": "#ffffff"
-}
+}

src/Components/Main/Contribute.js

@@ -0,0 +1,12 @@
+import React from "react";
+import "./Contribute.css";
+
+const Contribute = () => {
+  return (
+    <>
+      <h1 className='site-heading'>Contribute</h1>
+    </>
+  );
+};
+
+export default Contribute;