|
1 | | -# code_juge |
| 1 | +# CodeJudge: v.1.0.0 |
| 2 | +A simple, exam‑style code judge to help students practice and validate their programming logic. |
2 | 3 |
|
3 | | -A new Flutter project. |
| 4 | +## Overview |
| 5 | +- [Purpose & Benefits](#Purpose-&-Benefits) |
| 6 | +- [Features](#Features) |
| 7 | +- [Contribution-Guidelines](#Contribution-Guidelines) |
| 8 | +- [Contact](#Contact) |
| 9 | +- [Legal & Privacy](#Legal-&-Privacy) |
| 10 | + - *[License](#License)* |
| 11 | + - *[Legal & Transparency Statement](#Legal-&-Transparency-Statement)* |
| 12 | + - *[Third-Party Assets](#Third-Party-Assets)* |
| 13 | + - *[Data Usage Notice](#Data-Usage-Notice)* |
| 14 | + - *[Security Notice](#Security-Notice)* |
| 15 | + - *[Disclaimer](#Disclaimer)* |
4 | 16 |
|
5 | | -## Getting Started |
| 17 | +## 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**. |
| 20 | +All your code is stored locally on your device—**your data remains private and is never shared** by this app. |
6 | 21 |
|
7 | | -This project is a starting point for a Flutter application. |
| 22 | +## Features |
| 23 | +### Main Features |
| 24 | +- 10+ interesting exercises for your preparation |
| 25 | +- Exercises of varying difficulty |
| 26 | +- Training mode without any helpers |
| 27 | +- Fast and deterministic evaluation powered by a native C backend |
8 | 28 |
|
9 | | -A few resources to get you started if this is your first Flutter project: |
| 29 | +### Further Features |
| 30 | +- Light & dark mode support |
| 31 | +- Material You design guidelines |
| 32 | +- English & German translation |
10 | 33 |
|
11 | | -- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab) |
12 | | -- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook) |
| 34 | +## Contribution Guidelines |
| 35 | +Everyone is welcome to participate in and adapt this project. All contributions and usage are governed by the [Apache 2.0 License](LICENSE). |
| 36 | +Please see also [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. |
13 | 37 |
|
14 | | -For help getting started with Flutter development, view the |
15 | | -[online documentation](https://docs.flutter.dev/), which offers tutorials, |
16 | | -samples, guidance on mobile development, and a full API reference. |
| 38 | +### Getting Started |
| 39 | +Clone the repository: |
| 40 | +```bash |
| 41 | +git clone https://github.com/naibaf-1/CodeJudge.git |
| 42 | +``` |
| 43 | +### Code Of Conduct |
| 44 | +Please note that this project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md). |
| 45 | +By participating, you are expected to uphold this code. |
| 46 | + |
| 47 | +### Attribution |
| 48 | +If you fork and redistribute CodeJudge, please include the following attribution in your documentation: |
| 49 | +> Based on CodeJudge by Fabian Roland (naibaf-1) |
| 50 | +
|
| 51 | +## Contact |
| 52 | +You can contact me through GitHub—open an [issue](../../issues) or submit a pull request. |
| 53 | + |
| 54 | +## Legal & Privacy |
| 55 | +### License |
| 56 | +This project is licensed under the [Apache License 2.0](LICENSE). Please respect my [NOTICE.md](NOTICE) as well. |
| 57 | + |
| 58 | +### Legal & Transparency Statement |
| 59 | +For details regarding data usage, third-party content, and security practices, please refer to this README. |
| 60 | +This document is intended to provide full transparency for users and complies with the requirements of the Apache License 2.0 and relevant privacy standards. |
| 61 | + |
| 62 | +*If this app is distributed via an app store, the store description may refer to this README for further information.* |
| 63 | + |
| 64 | +### Third-Party Assets |
| 65 | +This app uses icons from the [Material Icons Library](https://fonts.google.com/icons) by Google, licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). |
| 66 | +© Google. Licensed under the Apache License, Version 2.0. |
| 67 | + |
| 68 | +### Data Usage Notice |
| 69 | +This app stores the code entered by the user locally on the device to process the user’s code and compare it with the solution. CodeJudge performs all evaluation locally on your device. |
| 70 | +No code is uploaded or transmitted to any server. All stored data is anonymous and used solely for functionality within the app. |
| 71 | + |
| 72 | +### 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. |
| 74 | +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 | +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 | + |
| 77 | +### 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! |
0 commit comments