You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -14,72 +14,50 @@ Visit this [Medium blog](https://medium.com/@ivchicano) for updates on the devel
14
14
-[Running, installing and development](README.md#running-installing-and-development)
15
15
-[General Roadmap](README.md#general-roadmap)
16
16
17
+
## Introduction
18
+
19
+
The main features are:
20
+
21
+
- Teachers can create courses and exercises for the students.
22
+
- Students can download these exercises and upload their updated files.
23
+
- Teachers can download the students’ exercises to see their progress.
24
+
25
+
There are 2 user roles: Teacher and Student.
26
+
27
+
- Teachers are capable of creating, editing, deleting, adding and removing users from courses. These courses have exercises, which have an associated template (files that serve as the base of the exercise) and each student’s files. Teachers can also download the students’ files to review them.
28
+
- Students can see these courses and exercises, download the templates and automatically upload their files to the server so that the teachers can see them.
29
+
17
30
## Common use case
18
31
19
-
1. Teacher runs the server, learning how to do it from [this link](/vscode4teaching-server/README.md)
20
-
2. Teacher installs the VSCode 4 Teaching extension from the [marketplace](https://marketplace.visualstudio.com/items?itemName=VSCode4Teaching.vscode4teaching):
32
+
1. Teacher installs the VSCode 4 Teaching extension from the [marketplace](https://marketplace.visualstudio.com/items?itemName=VSCode4Teaching.vscode4teaching):
21
33
22
-
3. Teacher signs up from superuser account and logs in:
23
-
24
-
4. Teacher creates a course and an exercise in that course:
34
+
2. Ask another teacher to create you an account (you can contact micael.gallego@urjc.es for a teacher account)
35
+
3. Teacher creates a course and adds exercises in that course (remember to use .gitignore to ignore the files you don't want to share!):
25
36
26
-
5. Teachers gets the code for sharing that course to his/her students:
37
+
4. Teacher can create a code for sharing the course with the students. Students with this code can see the course and download the exercises. Teachers gets the code for sharing that course to his/her students:
27
38
28
-
6. Students install the extension and sign up:
39
+
5. Students install the extension and sign up (if they don't have an account, only once):
9. Meanwhile the teacher checks the students' progress:
45
+
8. Meanwhile the teacher checks the students' progress using the dashboard. From the dashboard the teacher can open the last edited file of a student and see the difference between the template and that file:
10. When they finish the exercise, they mark it as finished:
47
+
9. When they finish the exercise, they mark it as finished:
37
48
38
-
11. Teacher starts checking on the students' solutions and adding comments:
49
+
10. Teacher starts checking on the students' solutions and adding comments:
39
50
40
-
12. Student checks the comments and responds to them:
51
+
11. Student checks the comments and responds to them:
41
52
42
53
43
-
## Introduction
44
-
45
-
The main features are:
46
-
47
-
- Teachers can create courses and exercises for the students.
48
-
- Students can download these exercises and upload their updated files.
49
-
- Teachers can download the students’ exercises to see their progress.
54
+
## Running, installing and development
50
55
51
56
The release comes with 2 artifacts: a server backend and the extension.
52
-
In the backend all the information is saved: courses, exercises, files… . The server is implemented as a REST API.
57
+
In the backend all the information is saved: courses, exercises, files… The server is implemented as a REST API.
53
58
54
59
The extension is a frontend to interact with the server API.
55
60
56
-
There are 2 user roles: Teacher and Student.
57
-
58
-
- Teachers are capable of creating, editing, deleting, adding and removing users from courses. These courses have exercises, which have an associated template (files that serve as the base of the exercise) and each student’s files. Teachers can also download the students’ files to review them.
59
-
- Students can see these courses and exercises, download the templates and automatically upload their files to the server so that the teachers can see them.
60
-
61
-
Animations showing the features:
62
-
In the first animation we see the teacher creating a course and then creating an exercise (and selecting the files that will be set as the template of the exercise):
On the next animation the student edits one of the files and saves it, triggering the automatic file upload so that the teacher can see it (notice the lower part of the screen how a message pops up indicating this upload):
On the next animation, we can see how the teacher selects the exercise previously created and downloads the edited files of the student that previously modified them:
69
-
70
-
A teacher can check differences between a students exercise and the original template:
71
-
0 commit comments