Skip to content
Snippets Groups Projects
Commit 383fbb97 authored by Sondre Alfnes's avatar Sondre Alfnes
Browse files

docs: Fix typos (!103)


- Fix typos in readme file
- Add check for empty input field when edit unit
- Remove SEO from documentation


Co-authored-by: default avatarSondre Alfnes <sondre.alfnes@gmail.com>
parent 3ce4cefd
No related branches found
No related tags found
1 merge request!103docs: Fix typos
Pipeline #286256 failed
......@@ -14,11 +14,11 @@ A demo video of the project can be found [here](https://www.youtube.com/watch?v=
The website uses Feide, which is a Norwegian authentication system. This means that in order to use the website, you have to be registrered as a student or a teacher in Norway.
After logging in, you will see a `Create new course +`-button if you are registered as a teacher in Feide. By clickin this button, you'll create a new course, and you will now see a new card-component on the home-screen representing this newly created course. Note: If you are enrolled into a course, the card-component will look the same, other than the badge saying `Student` instead of `Lecturer`.
After logging in, you will see a `Create new course +`-button if you are registered as a teacher in Feide. By clicking this button, you'll create a new course, and you will now see a new card-component on the home-screen representing this newly created course. Note: If you are enrolled into a course, the card-component will look the same, other than the badge saying `Student` instead of `Lecturer`.
<img src="./docs/Pictures/applicationView/homeScreen.png" width="50%" alt="Home Screen" />
After clickin on a course, you can create new units. Units represents the different lectures of the course. You can create a new unit by clicking the `Create new unit +`-button, and after creating a unit, you will see a new card-component on the course home-screen representing the newly created unit. When on the course home-screen, you can also click on `Invite users` to add students or lecturers to the course. After you've created a unit and the students have submitted some reflections, you can get a view like this:
After clicking on a course, you can create new units. Units represents the different lectures of the course. You can create a new unit by clicking the `Create new unit +`-button, and after creating a unit, you will see a new card-component on the course home-screen representing the newly created unit. When on the course home-screen, you can also click on `Invite users` to add students or lecturers to the course. After you've created a unit and the students have submitted some reflections, you can get a view like this:
Note: Here, we can see that the teacher has already generated a previous AI report for this unit, and that a new student has submitted a reflection for this unit since the last time the teacher generated a report.
<img src="./docs/Pictures/applicationView/coursePage.png" width="50%" alt="Course Page" />
......
......@@ -32,7 +32,7 @@ Having a dark mode feature in the application is a great way to reduce energy co
## Evaluation Tools
### Google Chrome Lighthouse
The Google Lighthouse tool is used to evaluate the performance, accessibility, best practices, and SEO of the application. It identifies issues such as HTML semantics, contrast issues, and keyboard navigation, enabling the team to address them promptly. Link to the tool: [Google Lighthouse](https://developers.google.com/web/tools/lighthouse)
The Google Lighthouse tool is used to evaluate the performance, accessibility and best practices of the application. It identifies issues such as HTML semantics, contrast issues, and keyboard navigation, enabling the team to address them promptly. Link to the tool: [Google Lighthouse](https://developers.google.com/web/tools/lighthouse)
Using Lighthouse, we found that we got a 100% score in all pages for Accessibility, Best Practices, and Performance. This shows that our application is well-optimized and accessible to all users.
......
......@@ -28,6 +28,10 @@
* @param form - The form data containing the unit title and date available.
*/
async function editUnit(form: FormData) {
if (!unitName || !availableDate) {
toast.error('Please fill in all fields');
return;
}
const response = await fetch(`${PUBLIC_API_URL}/update_unit/${data.unit_id}`, {
method: 'PATCH',
credentials: 'include',
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment