README
¶
About
Hakutest is an educational platform designed for testing in local network. It allows you to test students, conduct quizzes, and even take exams. In other words, you can use Hakutest for every task that requires automatic answer check.
Installation
Please refer to the Installation page on the website. Alternatively, check out the Releases page.
If you want to compile Hakutest from source, see BUILDING.md.
Why Hakutest?
Hakutest offers a fair number of advantages over its analogues:
- Efficiency — Hakutest is an efficient system capable of checking answers in a matter of milliseconds.
- Customizability — You can customize the system to suit your needs: internationalization, data export. etc.
- Easy to use — Hakutest has a clean and accessible interface, uses a familiar markup format (Markdown), etc.
- Cross-platform — Run Hakutest on Windows, Linux, in a graphical session or on a server.
- Security — Hakutest uses a reliable policy-based security model.
- Privacy — You own your data, period. Hakutest respects your privacy.
- Freedom — Hakutest is a free (as in freedom) and open source software.
How it works
Hakutest runs on the local network (but it can also be run on a global network as well). Each test is represented by a JSON file that is stored locally on your device. When the Hakutest server is running, students can access the test through the browser. The platform dynamically generates a web page for each test, displaying the questions and any additional content specified in the test file.
Once students have completed the test and submitted their answers, Hakutest automatically checks their responses against the expected solutions. This automated answer checking process provides instant feedback to students. The platform evaluates each answer based on the predefined criteria set in the test file, allowing for accurate and efficient grading.
By utilizing this approach, Hakutest ensures that the testing process is secure and reliable. Since the test files are stored locally, the platform maintains data privacy and prevents unauthorized access to sensitive information.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
hakuctl/cli
Package cli provides CLI interface for the `hakuctl` binary.
|
Package cli provides CLI interface for the `hakuctl` binary. |
|
hakuctl/runners
Package runners provides functions for the command line interface.
|
Package runners provides functions for the command line interface. |
|
internal
|
|
|
app/server
Package server provides HTTP server for the app.
|
Package server provides HTTP server for the app. |
|
app/server/controllers
Package controllers provides controllers for github.com/gin-gonic/gin.
|
Package controllers provides controllers for github.com/gin-gonic/gin. |
|
app/tray
Package tray provides constants and helpers for tray app.
|
Package tray provides constants and helpers for tray app. |
|
pkg/browser
Package browser provides utility functions that open teacher dashboard in the browser.
|
Package browser provides utility functions that open teacher dashboard in the browser. |
|
pkg/config
Package config provides configuration for the app.
|
Package config provides configuration for the app. |
|
pkg/i18n
Package i18n provides internationalization for the application.
|
Package i18n provides internationalization for the application. |
|
pkg/markdown
Package markdown provides encapsulated methods to convert Markdown to HTML.
|
Package markdown provides encapsulated methods to convert Markdown to HTML. |
|
pkg/network
Package network provides network utilities.
|
Package network provides network utilities. |
|
pkg/paths
Package paths provides XDG-compliant common paths for the application.
|
Package paths provides XDG-compliant common paths for the application. |
|
pkg/security
Package security provides private security methods.
|
Package security provides private security methods. |
|
pkg/uptime
Package uptime provides method to get application uptime.
|
Package uptime provides method to get application uptime. |
|
pkg
|
|
|
result
Package result provides results management for the app.
|
Package result provides results management for the app. |
|
statistics
Package statistics provides methods for exporting statistics of the testing results.
|
Package statistics provides methods for exporting statistics of the testing results. |
|
test
Package test provides functionality to manipulate tests.
|
Package test provides functionality to manipulate tests. |
|
version
Package version provides Hakutest version.
|
Package version provides Hakutest version. |
|
Package web provides embedded file systems for the web server.
|
Package web provides embedded file systems for the web server. |