Merge branch 'development' into frontend/docutation/readme-update

SELab-2 · May 13, 2024 · 13c9296 · 13c9296
2 parents c01e755 + 1d0b4f8
commit 13c9296
Show file tree

Hide file tree

Showing 58 changed files with 405 additions and 311 deletions.
diff --git a/backend/project/endpoints/projects/project_submissions_download.py b/backend/project/endpoints/projects/project_submissions_download.py
@@ -51,9 +51,6 @@ def get_last_submissions_per_user(project_id):
         (Submission.submission_time == latest_submissions.c.max_time)
     ).all()
 
-    if not submissions:
-        return {"message": "No submissions found", "url": BASE_URL}, 404
-
     return {"message": "Resource fetched succesfully", "data": submissions}, 200
 
 class SubmissionDownload(Resource):

diff --git a/backend/project/endpoints/users.py b/backend/project/endpoints/users.py
@@ -34,6 +34,10 @@ def get(self):
                 role = Role[role.upper()]
                 query = query.filter(userModel.role == role)
 
+            uid = request.args.getlist("uid")
+            if len(uid) > 0:
+                query = query.filter(userModel.uid.in_(uid))
+
             users = query.all()
             users = [user.to_dict() for user in users]
 

diff --git a/documentation/documentation/.gitignore → documentation/.gitignore b/documentation/documentation/.gitignore → documentation/.gitignore
@@ -17,4 +17,4 @@
 
 npm-debug.log*
 yarn-debug.log*
-yarn-error.log*
+yarn-error.log*
diff --git a/documentation/README.md b/documentation/README.md
@@ -0,0 +1,27 @@
+# UGent-3 project peristerónas user guide
+
+## Introduction
+Project peristerónas has a lot of features, therefore a detailed user guide is available to consult.
+
+## Usage
+### Development
+If you want to develop on the site, run the following command:
+  ```sh
+   npm run start
+   ```
+This creates a lightweight version of the site, if you want to test a certain language version of the site you can use the command:
+  ```sh
+    npm run start -- --locale [language]
+  ```
+
+  ### Deployment
+  When you're ready to deploy, run the following command to run the proper version of the site:
+  ```sh
+  npm run build
+  ```
+
+  A static version will be built that you can access in the directory `build/`, you can then run the static site by using the command:
+
+  ```sh
+  npm run serve
+  ```
diff --git a/documentation/documentation/babel.config.js → documentation/babel.config.js b/documentation/documentation/babel.config.js → documentation/babel.config.js
diff --git a/...mentation/docs/evaluators/_category_.json → ...mentation/docs/evaluators/_category_.json b/...mentation/docs/evaluators/_category_.json → ...mentation/docs/evaluators/_category_.json
diff --git a/...ation/docs/evaluators/custom_evaluator.md → ...ation/docs/evaluators/custom_evaluator.md b/...ation/docs/evaluators/custom_evaluator.md → ...ation/docs/evaluators/custom_evaluator.md
diff --git a/...tion/docs/evaluators/general_evaluator.md → ...tion/docs/evaluators/general_evaluator.md b/...tion/docs/evaluators/general_evaluator.md → ...tion/docs/evaluators/general_evaluator.md
diff --git a/...ation/docs/evaluators/python_evaluator.md → ...ation/docs/evaluators/python_evaluator.md b/...ation/docs/evaluators/python_evaluator.md → ...ation/docs/evaluators/python_evaluator.md
diff --git a/documentation/documentation/docs/intro.md → documentation/docs/intro.md b/documentation/documentation/docs/intro.md → documentation/docs/intro.md
diff --git a/...entation/docs/projectform/_category_.json → ...entation/docs/projectform/_category_.json b/...entation/docs/projectform/_category_.json → ...entation/docs/projectform/_category_.json
diff --git a/.../documentation/docs/projectform/image.png → documentation/docs/projectform/image.png b/.../documentation/docs/projectform/image.png → documentation/docs/projectform/image.png
diff --git a/...n/docs/projectform/project_upload_form.md → ...n/docs/projectform/project_upload_form.md b/...n/docs/projectform/project_upload_form.md → ...n/docs/projectform/project_upload_form.md
diff --git a/documentation/documentation/README.md b/documentation/documentation/README.md
diff --git a/...n/i18n/nl/docusaurus-plugin-content-docs/current/evaluators/python_evaluator.md b/...n/i18n/nl/docusaurus-plugin-content-docs/current/evaluators/python_evaluator.md
diff --git a/...tation/documentation/docusaurus.config.ts → documentation/docusaurus.config.ts b/...tation/documentation/docusaurus.config.ts → documentation/docusaurus.config.ts
diff --git a/...t-docs/current/evaluators/_category_.json → ...t-docs/current/evaluators/_category_.json b/...t-docs/current/evaluators/_category_.json → ...t-docs/current/evaluators/_category_.json
diff --git a/...cs/current/evaluators/custom_evaluator.md → ...cs/current/evaluators/custom_evaluator.md b/...cs/current/evaluators/custom_evaluator.md → ...cs/current/evaluators/custom_evaluator.md
diff --git a/...s/current/evaluators/general_evaluator.md → ...s/current/evaluators/general_evaluator.md b/...s/current/evaluators/general_evaluator.md → ...s/current/evaluators/general_evaluator.md
diff --git a/...n/i18n/nl/docusaurus-plugin-content-docs/current/evaluators/python_evaluator.md b/...n/i18n/nl/docusaurus-plugin-content-docs/current/evaluators/python_evaluator.md
@@ -0,0 +1,13 @@
+# Python evaluator
+## Algemeen gebruik
+Deze evaluator is verantwoordelijk voor het uitvoeren en testen van de Python-code van een student.
+
+## Structuur
+Bij het indienen van het project kan een leraar vereisten toevoegen via het bestand `req-manifest.txt`. Op deze manier zijn alleen de pakketten in het vereistenbestand bruikbaar op de evaluator.
+
+Wanneer er geen manifest aanwezig is, kunnen studenten hun eigen paketten installeren met een `requirements.txt` en een `dev-requirements.txt`.
+Of de leraar kan een `requirements.txt` toevoegen als ze paketten vooraf willen installeren die aanwezig moeten zijn voor het testen van het project.
+
+## Tests uitvoeren
+Als er een `run_tests.sh` aanwezig is in de projectopdrachtbestanden, wordt dit uitgevoerd wanneer de student zijn code indient.
+Bij het uitvoeren van tests is het belangrijk op te merken dat de map van de inzending van de student `/submission` zal zijn.
diff --git a/...urus-plugin-content-docs/current/intro.md → ...urus-plugin-content-docs/current/intro.md b/...urus-plugin-content-docs/current/intro.md → ...urus-plugin-content-docs/current/intro.md
diff --git a/...urrent/projectform/project_upload_form.md → ...urrent/projectform/project_upload_form.md b/...urrent/projectform/project_upload_form.md → ...urrent/projectform/project_upload_form.md
diff --git a/...mentation/documentation/package-lock.json → documentation/package-lock.json b/...mentation/documentation/package-lock.json → documentation/package-lock.json
diff --git a/documentation/documentation/package.json → documentation/package.json b/documentation/documentation/package.json → documentation/package.json
diff --git a/documentation/documentation/sidebars.ts → documentation/sidebars.ts b/documentation/documentation/sidebars.ts → documentation/sidebars.ts
diff --git a/...src/components/HomepageFeatures/index.tsx → ...src/components/HomepageFeatures/index.tsx b/...src/components/HomepageFeatures/index.tsx → ...src/components/HomepageFeatures/index.tsx
diff --git a/...onents/HomepageFeatures/styles.module.css → ...onents/HomepageFeatures/styles.module.css b/...onents/HomepageFeatures/styles.module.css → ...onents/HomepageFeatures/styles.module.css
diff --git a/...entation/documentation/src/css/custom.css → documentation/src/css/custom.css b/...entation/documentation/src/css/custom.css → documentation/src/css/custom.css
diff --git a/.../documentation/src/pages/index.module.css → documentation/src/pages/index.module.css b/.../documentation/src/pages/index.module.css → documentation/src/pages/index.module.css
diff --git a/...ntation/documentation/src/pages/index.tsx → documentation/src/pages/index.tsx b/...ntation/documentation/src/pages/index.tsx → documentation/src/pages/index.tsx
diff --git a/documentation/documentation/static/.nojekyll → documentation/static/.nojekyll b/documentation/documentation/static/.nojekyll → documentation/static/.nojekyll
diff --git a/...ion/documentation/static/img/logo_app.png → documentation/static/img/logo_app.png b/...ion/documentation/static/img/logo_app.png → documentation/static/img/logo_app.png
diff --git a/...n/documentation/static/img/logo_ugent.png → documentation/static/img/logo_ugent.png b/...n/documentation/static/img/logo_ugent.png → documentation/static/img/logo_ugent.png
diff --git a/...cumentation/static/img/project_form_1.png → documentation/static/img/project_form_1.png b/...cumentation/static/img/project_form_1.png → documentation/static/img/project_form_1.png
diff --git a/...cumentation/static/img/project_form_2.png → documentation/static/img/project_form_2.png b/...cumentation/static/img/project_form_2.png → documentation/static/img/project_form_2.png
diff --git a/...tion/static/img/project_upload_form_3.png → ...tion/static/img/project_upload_form_3.png b/...tion/static/img/project_upload_form_3.png → ...tion/static/img/project_upload_form_3.png
diff --git a/...tion/static/img/project_upload_form_4.png → ...tion/static/img/project_upload_form_4.png b/...tion/static/img/project_upload_form_4.png → ...tion/static/img/project_upload_form_4.png
diff --git a/...tion/static/img/project_upload_form_5.png → ...tion/static/img/project_upload_form_5.png b/...tion/static/img/project_upload_form_5.png → ...tion/static/img/project_upload_form_5.png
diff --git a/...tion/static/img/project_upload_form_6.png → ...tion/static/img/project_upload_form_6.png b/...tion/static/img/project_upload_form_6.png → ...tion/static/img/project_upload_form_6.png
diff --git a/...tion/static/img/project_upload_form_7.png → ...tion/static/img/project_upload_form_7.png b/...tion/static/img/project_upload_form_7.png → ...tion/static/img/project_upload_form_7.png
diff --git a/...static/img/undraw_docusaurus_mountain.svg → ...static/img/undraw_docusaurus_mountain.svg b/...static/img/undraw_docusaurus_mountain.svg → ...static/img/undraw_docusaurus_mountain.svg
diff --git a/...on/static/img/undraw_docusaurus_react.svg → ...on/static/img/undraw_docusaurus_react.svg b/...on/static/img/undraw_docusaurus_react.svg → ...on/static/img/undraw_docusaurus_react.svg
diff --git a/...ion/static/img/undraw_docusaurus_tree.svg → ...ion/static/img/undraw_docusaurus_tree.svg b/...ion/static/img/undraw_docusaurus_tree.svg → ...ion/static/img/undraw_docusaurus_tree.svg
diff --git a/documentation/documentation/tsconfig.json → documentation/tsconfig.json b/documentation/documentation/tsconfig.json → documentation/tsconfig.json
diff --git a/frontend/public/locales/nl/translation.json b/frontend/public/locales/nl/translation.json
@@ -93,7 +93,8 @@
     "noFilesPlaceholder": "Nog geen opgave bestanden geupload",
     "noRegexPlaceholder": "Nog geen regex toegevoegd",
     "unauthorized": "U heeft niet de juiste rechten om een project aan te maken voor dit vak",
-    "submissionError": "Er is een fout opgetreden bij het indienen van uw project, probeer het later opnieuw."
+    "submissionError": "Er is een fout opgetreden bij het indienen van uw project, probeer het later opnieuw.",
+    "clearSelected": "Deselecteer keuze"
   },
   "projectView": {
     "submitNetworkError": "Er is iets mislopen bij het opslaan van uw indiening. Probeer het later opnieuw.",

diff --git a/frontend/src/App.tsx b/frontend/src/App.tsx
@@ -22,6 +22,7 @@ import ProjectOverView from "./pages/project/projectOverview.tsx";
 import { synchronizeJoinCode } from "./loaders/join-code.ts";
 import { fetchMe } from "./utils/fetches/FetchMe.ts";
 import {fetchProjectForm} from "./components/ProjectForm/project-form.ts";
+import loadSubmissionOverview from "./loaders/submission-overview-loader.ts";
 
 const router = createBrowserRouter(
   createRoutesFromElements(
@@ -34,10 +35,6 @@ const router = createBrowserRouter(
       <Route index element={<HomePages />} loader={fetchProjectPage} />
       <Route path=":lang" element={<LanguagePath />}>
         <Route path="home" element={<HomePages />} loader={fetchProjectPage} />
-        <Route
-          path="project/:projectId/overview"
-          element={<SubmissionsOverview />}
-        />
         <Route path="courses">
           <Route index element={<AllCoursesTeacher />} loader={dataLoaderCourses}/>
           <Route path="join" loader={synchronizeJoinCode} />
@@ -49,6 +46,11 @@ const router = createBrowserRouter(
             element={<ProjectOverView />}
             loader={fetchProjectPage}
           />
+          <Route
+            loader={loadSubmissionOverview}
+            path=":projectId/overview"
+            element={<SubmissionsOverview />}
+          />
           <Route path=":projectId" element={<ProjectView />}></Route>
           <Route path="create" element={<ProjectCreateHome />} loader={fetchProjectForm}/>
         </Route>

diff --git a/frontend/src/components/Courses/AllCoursesTeacher.tsx b/frontend/src/components/Courses/AllCoursesTeacher.tsx
@@ -3,7 +3,7 @@ import { useState } from "react";
 import { useTranslation } from "react-i18next";
 import { useNavigate } from "react-router-dom";
 import { SideScrollableCourses } from "./CourseUtilComponents";
-import { Course, callToApiToCreateCourse } from "./CourseUtils";
+import {Course, callToApiToCreateCourse, ProjectDetail} from "./CourseUtils";
 import { Title } from "../Header/Title";
 import { useLoaderData } from "react-router-dom";
 
@@ -12,7 +12,12 @@ import { useLoaderData } from "react-router-dom";
  */
 export function AllCoursesTeacher(): JSX.Element {
   const [open, setOpen] = useState(false);
-  const courses = (useLoaderData() as Course[]);
+  const loader = useLoaderData() as {
+    courses: Course[];
+    projects: { [courseId: string]: ProjectDetail[] }
+  };
+  const courses = loader.courses;
+  const projects = loader.projects;
 
   const [courseName, setCourseName] = useState('');
   const [error, setError] = useState('');
@@ -49,7 +54,7 @@ export function AllCoursesTeacher(): JSX.Element {
     <>
       <Title title={t('title')}></Title>
       <Grid container direction={'column'} style={{marginTop: '1rem', width:'100vw', height: '80vh'}}>
-        <SideScrollableCourses courses={courses}></SideScrollableCourses>
+        <SideScrollableCourses courses={courses} projects={projects}></SideScrollableCourses>
         <Dialog open={open} onClose={handleClose}>
           <DialogTitle>{t('courseForm')}</DialogTitle>
           <form style={{ margin: "2rem" }} onSubmit={handleSubmit}>

diff --git a/frontend/src/components/Courses/CourseDetailTeacher.tsx b/frontend/src/components/Courses/CourseDetailTeacher.tsx
@@ -14,6 +14,7 @@ import {
   Menu,
   MenuItem,
   Paper,
+  Tooltip,
   Typography,
 } from "@mui/material";
 import { ChangeEvent, useCallback, useEffect, useState } from "react";
@@ -24,7 +25,6 @@ import {
   getIdFromLink,
   getNearestFutureDate,
   getUser,
-  appHost,
   ProjectDetail,
 } from "./CourseUtils";
 import {
@@ -39,6 +39,7 @@ import { timeDifference } from "../../utils/date-utils";
 import { authenticatedFetch } from "../../utils/authenticated-fetch";
 import i18next from "i18next";
 import { Me } from "../../types/me";
+import ContentCopyIcon from "@mui/icons-material/ContentCopy";
 
 interface UserUid {
   uid: string;
@@ -179,9 +180,17 @@ export function CourseDetailTeacher(): JSX.Element {
   return (
     <>
       <Title title={course.name}></Title>
-      <Grid container direction={"row"} spacing={2} margin="1rem">
-        <Grid item xs={5}>
-          <Paper style={{ height: "90%", maxHeight: "90vh" }}>
+      <Grid
+        container
+        direction={"row"}
+        spacing={2}
+        margin="1rem"
+        style={{ height: "80vh" }}
+      >
+        <Grid item xs={5} height="100%">
+          <Paper
+            style={{ height: "100%", maxHeight: "100%", overflow: "auto" }}
+          >
             <div style={{ padding: "1rem" }}>
               <Typography variant="h5">{t("projects")}:</Typography>
               <EmptyOrNotProjects projects={projects} />
@@ -191,19 +200,12 @@ export function CourseDetailTeacher(): JSX.Element {
             <Button>{t("newProject")}</Button>
           </Link>
         </Grid>
-        <Grid item xs={6}>
-          <Grid
-            container
-            direction={"column"}
-            spacing={2}
-            style={{
-              height: "100%",
-            }}
-          >
+        <Grid item xs={5} height="100%">
+          <Grid container direction={"column"} spacing={2} height={"100%"}>
             <Grid
               item
               style={{
-                height: "45.9%",
+                height: "50%",
               }}
             >
               <Paper
@@ -239,7 +241,7 @@ export function CourseDetailTeacher(): JSX.Element {
             <Grid
               item
               style={{
-                height: "45.9%",
+                height: "50%",
               }}
             >
               <Paper
@@ -255,22 +257,6 @@ export function CourseDetailTeacher(): JSX.Element {
                   handleCheckboxChange={handleCheckboxChange}
                 />
               </Paper>
-
-              <IconButton
-                style={{ position: "absolute", bottom: 0, left: 0 }}
-                onClick={() =>
-                  handleDeleteStudent(
-                    navigate,
-                    course.course_id,
-                    selectedStudents
-                  )
-                }
-              >
-                <ClearIcon />
-                <Typography variant="body1">{t("deleteSelected")}</Typography>
-              </IconButton>
-            </Grid>
-            <Grid item>
               <Grid container>
                 <Grid item>
                   <Button onClick={handleClickCodes}>{t("joinCodes")}</Button>
@@ -291,6 +277,20 @@ export function CourseDetailTeacher(): JSX.Element {
                   </Button>
                 </Grid>
               </Grid>
+
+              <IconButton
+                style={{ position: "absolute", bottom: 0, left: 0 }}
+                onClick={() =>
+                  handleDeleteStudent(
+                    navigate,
+                    course.course_id,
+                    selectedStudents
+                  )
+                }
+              >
+                <ClearIcon />
+                <Typography variant="body1">{t("deleteSelected")}</Typography>
+              </IconButton>
             </Grid>
           </Grid>
         </Grid>
@@ -486,7 +486,10 @@ function JoinCodeMenu({
   };
 
   const handleCopyToClipboard = (join_code: string) => {
-    navigator.clipboard.writeText(`${appHost}/join-course?code=${join_code}`);
+    const host = window.location.host;
+    navigator.clipboard.writeText(
+      `${host}/${i18next.language}/courses/join?code=${join_code}`
+    );
   };
 
   const getCodes = useCallback(() => {
@@ -560,6 +563,9 @@ function JoinCodeMenu({
           vertical: "bottom",
           horizontal: "center",
         }}
+        style={{
+          width: "25vw",
+        }}
       >
         <MenuItem disabled>
           <Typography variant="h6">{t("joinCodes")}</Typography>
@@ -568,25 +574,33 @@ function JoinCodeMenu({
           elevation={0}
           style={{
             margin: "1rem",
+            width: "100%",
+            maxHeight: "20vh",
+            height: "20vh",
+            overflowY: "auto",
           }}
         >
           {codes.map((code: JoinCode) => (
-            <MenuItem
-              onClick={() => handleCopyToClipboard(code.join_code)}
-              key={code.join_code}
-            >
+            <MenuItem style={{ width: "100%" }} key={code.join_code}>
               <Grid container direction={"row"}>
-                <Grid marginRight={"1rem"} item>
-                  <Typography variant="body1">
-                    {code.expiry_time
-                      ? timeDifference(code.expiry_time)
-                      : t("noExpiryDate")}
-                  </Typography>
-                </Grid>
-                <Grid item>
-                  <Typography variant="body1">
-                    {code.for_admins ? t("forAdmins") : t("forStudents")}
-                  </Typography>
+                <Grid item flexGrow={1}>
+                  <Box display="flex" gap="1rem">
+                    <Typography variant="body1">
+                      {code.expiry_time
+                        ? timeDifference(code.expiry_time)
+                        : t("noExpiryDate")}
+                    </Typography>
+                    <Typography variant="body1">
+                      {code.for_admins ? t("forAdmins") : t("forStudents")}
+                    </Typography>
+                    <Tooltip title={t("copyToClipboard")}>
+                      <IconButton
+                        onClick={() => handleCopyToClipboard(code.join_code)}
+                      >
+                        <ContentCopyIcon />
+                      </IconButton>
+                    </Tooltip>
+                  </Box>
                 </Grid>
                 <Grid item>
                   <IconButton onClick={() => handleDeleteCode(code.join_code)}>