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
Updated README to enhance clarity and detail about the project and its C backend, including tech stack, purpose, features, and architecture overview. Added screenshots.
@@ -13,10 +21,10 @@ A simple, exam‑style code judge to help students practice and validate their p
13
21
-*[Data Usage Notice](#Data-Usage-Notice)*
14
22
-*[Security Notice](#Security-Notice)*
15
23
-*[Disclaimer](#Disclaimer)*
24
+
-[Screenshots](#Screenshots)
16
25
17
26
## Purpose & Benefits
18
-
CodeJudge is designed to help computer science students practice and prepare for their programming exams. It simulates a real exam environment — without syntax highlighting, auto‑completion,
19
-
or other IDE helpers. While it might help you to improve your skills, **there is no guarantee that it will improve your skills or grades**.
27
+
CodeJudge is designed to help computer science students practice and prepare for their programming exams. It combines a modern Flutter UI with a high‑performance native C backend to simulate real exam conditions — without syntax highlighting, auto‑completion, or other IDE helpers. While it might help you to improve your skills, **there is no guarantee that it will improve your skills or grades**.
20
28
All your code is stored locally on your device—**your data remains private and is never shared** by this app.
21
29
22
30
## Features
@@ -25,11 +33,16 @@ All your code is stored locally on your device—**your data remains private and
25
33
- Exercises of varying difficulty
26
34
- Training mode without any helpers
27
35
- Fast and deterministic evaluation powered by a native C backend
36
+
- Basic error messages by the backend
28
37
29
38
### Further Features
30
39
- Light & dark mode support
31
40
- Material You design guidelines
32
41
- English & German translation
42
+
- Responsive UI
43
+
44
+
## Installation & Support
45
+
At the moment CodeJudge supports just Linux currently. Maybe another plattform will follow soon.
33
46
34
47
## Contribution Guidelines
35
48
Everyone is welcome to participate in and adapt this project. All contributions and usage are governed by the [Apache 2.0 License](LICENSE).
CodeJudge consists of two tightly integrated components:
58
+
59
+
1.**Flutter Frontend (Dart)**
60
+
- User interface
61
+
- Training mode
62
+
- Localization & theming
63
+
- Exercises
64
+
65
+
2.**Native C Backend**
66
+
- Compiles and executes user code
67
+
- Compares output with expected results
68
+
- Returns deterministic responses
69
+
70
+
### Code Structure
71
+
-`/lib` — Flutter UI (Dart)
72
+
-`/native` — CodeJudge engine (C)
73
+
43
74
### Code Of Conduct
44
75
Please note that this project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md).
45
76
By participating, you are expected to uphold this code.
@@ -70,9 +101,15 @@ This app stores the code entered by the user locally on the device to process th
70
101
No code is uploaded or transmitted to any server. All stored data is anonymous and used solely for functionality within the app.
71
102
72
103
### Security Notice
73
-
This app generates a file containing the Code entered by the user. This file is necessary for the whole backend and it's overwritten as soon as the user enters Code using the same programming language.
104
+
This app generates a file containing the code entered by the user. This file is necessary for the whole backend and it's overwritten as soon as the user enters code using the same programming language.
74
105
While no personal data is collected or transmitted, users should be aware that unencrypted data may be accessible to other apps on the same device.
75
106
To mitigate this risk, we recommend using devices with secure storage and keeping your system up to date. All data remains local and anonymous.
76
107
77
108
### Disclaimer
78
-
This app was developed to help computer science students preparing for their exams written on paper or at least without helpers like syntax highlighting. This means that CodeJudge intentionally provides no helpers such as syntax highlighting or auto‑completion. Since this app depends on good exercises feel free to add or improve exercises!
109
+
This app was developed to help computer science students preparing for their exams written on paper or at least without helpers like syntax highlighting. This means that CodeJudge intentionally provides no helpers such as syntax highlighting or auto‑completion. Since this app depends on good exercises, feel free to add or improve exercises!
110
+
111
+
## Screenshots
112
+
|<imgsrc="./assets/screenshots/Exercises.png"width="540"/> <br>**See all exercises**|<imgsrc="./assets/screenshots/Informations_Overlay.png"width="540"/> <br>**See details**|
0 commit comments