SchoolExam Correction UI

project_description
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

SchoolExam has originated from a design thinking process developed as part of a course about software engineering with the goal of improving the exam process and exam management at schools. This repository is the component allowing teachers to correct the digitalized submissions.

Built With

• Flutter
• flutter_bloc
• perfect_freehand
• syncfusion_flutter_pdf
• native_pdf_view

(back to top)

Getting Started

As the correction UI is just one component of an overall system, dependencies require their existence.

(back to top)

Prerequisites

For the UI to properly function, a running instance of the SchoolExam backend is required. Further information can be found here.

After setting up the backend, u require Flutter (and an appropriate development environment). Using flutter the dependencies of the project are retrieved using.

flutter pub get

Before starting your application, configure the api.cfg found in the assets to point to your SchoolExam backend.

(back to top)

Usage

After setting up a working environment, the UI can be used to (mainly) correct uploaded submissions.

(back to top)

Roadmap

• implement various analytics for individual students to analyze and optimize teaching at schools
• support randomization of tasks
• support exams (writing tasks) that have a grading scheme different from points
• add additional pages dynamically during exams based on demand
• API for review such that points can be corrected based on complaints from students
• store correction overlay independent from scanned PDF
• image recognition for automized correction (multiple choice, matching)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Torben Soennecken - [email protected]

Project Link: https://github.com/SoftwareEngineering-WS2022-CoCoMonkeys/schoolexam-correction-ui

(back to top)

Acknowledgments

• #wirfuerschule for the insights on the current situation in schools
• Capgemini for the valuable workshops with feedback for the architecture
• ISSE chair at the University of Augsburg for giving us room to implement our idea
• adesso for providing us a productive collaborative workspace

(back to top)