https://github.com/digabi/exam-engine
Toolkit for creating exams for the Abitti exam system
https://github.com/digabi/exam-engine
Last synced: 5 months ago
JSON representation
Toolkit for creating exams for the Abitti exam system
- Host: GitHub
- URL: https://github.com/digabi/exam-engine
- Owner: digabi
- License: other
- Created: 2019-11-22T08:29:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-12T03:38:44.000Z (5 months ago)
- Last Synced: 2026-01-12T10:33:46.050Z (5 months ago)
- Language: TypeScript
- Homepage: https://digabi.github.io/exam-engine/MexDocumentation/
- Size: 475 MB
- Stars: 16
- Watchers: 20
- Forks: 8
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://digabi.fi)
# Digabi
Digabi is a codebase used in the Abitti exam system, the digital exam environment for the [Finnish Matriculation Examination](https://www.ylioppilastutkinto.fi/en).
All bug reports, feature requests, and pull requests are appreciated. However, the following should be kept in mind:
- Pull requests based on submitted issues cannot be implemented due to limited resources. Similarly, upstream issues related to third-party projects in use are not forwarded.
- No guarantee can be given that submitted pull requests will be reviewed.
- Our focus is strictly on the Finnish Matriculation Examination, as defined by law. Issues or pull requests unrelated to this mission will not be addressed.
- Official channels should be used for inquiries. The issue tracker and pull requests are not to be used for general questions or support requests.
Before any contribution is accepted to the codebase, to clarify the intellectual property rights associated with contributions to open-source projects owned by the Finnish Matriculation Examination Board, all contributors must sign and submit a Contribution License Agreement (CLA):
- Individuals should sign and send the [Personal CLA](https://digabi.fi/YTL%20Personal%20CLA.pdf) to [digabi@ylioppilastutkinto.fi](mailto:digabi@ylioppilastutkinto.fi).
- Organizations or corporations should sign and send the [Corporate CLA](https://digabi.fi/YTL%20Corporate%20CLA.pdf) to the same address.
# Digabi Exam Engine
[Documentation](https://digabi.github.io/exam-engine/MexDocumentation/)
Engine for the MEX exam format.
Provides:
- Exam preview tools for exam developers
- MEX format documentation
- Tools for mastering an exam to run it in Matriculation examination board's environment
**Make sure you test any MEX format exam manually before publishing it or using it with Abitti in
production. This manual testing should include holding the exam, answering all questions, grading
it, and checking that all examinees' answers are available.**
**The MEX format and this engine is still under development: All functionalities of the MEX format
do not yet work in Abitti. Breaking changes are also still possible without prior warning.**
# Setup
Make sure the following are installed in your system:
- [Node.js](https://nodejs.org/en/) `nvm install` and/or `nvm use`
- [Firefox](https://www.mozilla.org/fi-FI/firefox/new/)
After Node.js has been installed, open a new terminal window and type the
following command.
```
$ npm install -g @digabi/exam-engine-cli
```
This installs the `ee` command-line program to your system.
# Creating a new exam
To create a new exam, use
```
$ ee new Esimerkkikoe
```
This creates a `Esimerkkikoe` directory, containing a basic `exam.xml` file and an
empty `attachments` directory where to place attachments.
# Preview
To start a live preview of any exam on your computer, navigate to the exam
directory and run
```
$ ee preview
```
# Importing an exam to Abitti
To use an exam in Abitti, it must be first packaged as a transfer zip. It is
then possible to import it to Abitti by clicking "Tuo koe/För in prov".
To create a transfer zip, navigate to the exam directory and run
```
$ ee create-transfer-zip
```
This creates a transfer zip file in the exam directory for each language
version of the exam.
# Offline versions
Offline version refers to a static version of an exam that can be viewed in
a web browser without any additional tools.
To create an offline version of the exam, navigate to the exam directory and
use
```
$ ee create-offline
```
# Intellectual property rights
Most of the artifacts in this repository are licensed under [LICENSE](LICENSE). Exceptions are:
- XHTML-based XML Schema Definition files [packages/mastering/schema](packages/mastering/schema).
See [packages/mastering/schema/xhtml11.xsd](packages/mastering/schema/xhtml11.xsd) for the license.
- Abitti and the Abitti logo are EU trademarks registered by the Finnish Matriculation Examination
Board (FMEB) under the codes 015833742 and 015838915.
For detailed use rights, see [https://abitti.net/abitti-trademark.html](https://abitti.net/abitti-trademark.html)
- Several attachments in the SC sample exam [packages/exams/SC/](packages/exams/SC/) are third party material. See
the `` tags in [packages/exams/SC/SC.xml](packages/exams/SC/SC.xml) for details.
# Development
The information in this section is only relevant for developers.
## Architecture
Exam-engine is structured as a monorepo containing several NPM packages.
| Component | Purpose |
| --------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [@digabi/exam-engine-core](packages/core) | The main UI code responsible for rendering a mastered exam into HTML. It produces an AMD bundle containing several React components and a CSS file. This AMD bundle is packaged to every exam .mex file and loaded dynamically when taking the exam. |
| [@digabi/exam-engine-mastering](packages/mastering) | Mastering is a step in which we take a source XML file, validate its contents, do some processing (e.g. calculate the maximum score and assign IDs for each question). A single source XML file will produce a separate mastered XML file for each language defined in the source XML. |
| [@digabi/exam-engine-rendering](packages/rendering) | Contains webpack-related code for previewing an exam or converting one into a static HTML file (also known as an "offline exam"). |
| [@digabi/exam-engine-exams](packages/exams) | Contains sample exams in the mex format. |
| [@digabi/exam-engine-cli](packages/cli) | Contains the `ee` CLI tool. |
## Preview
The `ee` client can be run with `npm run ee`. So to preview an exam, run
```
$ npm run ee preview path/to/exam.xml
```
## Compilation
Before doing any changes to the code, you'll want to command TypeScript to compile
any changes within the whole project automatically.
```
$ npm run watch
```
## Lint
```
$ npm run lint
```
## Tests
To run all tests
```
$ npm run test
```
To run a specific test or a specific set of tests, use
```
$ npm run test packages/foo/__tests__/testFoo.ts
$ npm run test packages/foo
```
If you've made changes to the code that affect exam mastering or rendering,
you need to update the test snapshots by running. Review changes the snapshots manually.
```
$ npm run test-jest -- -u
```
## NPM releases
### Prerelease
Increase version number of the packages:
```bash
$ npx lerna version premajor | preminor | prepatch | prerelease [--force-publish] [--yes]
```
Use `--force-publish` to set new version even when there are no changes and `--yes` to auto-confirm
version to be set. This will create a tag for new version and push it to the remote repository.
GitHub Action will be triggered to publish new version to npm repository after successfully building
the repositories and running tests.
### Production release
Similar to prerelease, just
```bash
$ npx lerna version major | minor | patch [--force-publish] [--yes]
```