Project Even-Playfield (E-PF)

AI-assisted responsible grading tool for programming assignments. A GPT-wrapper in CLI for CS graders.

Usage

Make sure you have Bun installed. To run:

bunx --bun even-pf [config]

The config can be an absolute or relative path. Can also be a URL. If not specified, it will first try to get EPF_CONFIG_URL environment variable, then look for epf.toml in the current and the home directory.

If you're using the tool in a resource-constrained environment, you can use platform-specific executables like even-pf-linux-x64.

Development

To install dependencies:

bun install

To install as a tool globally:

bun link -g e-pf

Make sure you have a config file in your home or current directory. Alternatively, you can set environment variable EPF_CONFIG_URL.

This project was created using bun init in bun v1.3.2. Bun is a fast all-in-one JavaScript runtime.

Publishing

After making changes, you might want to bump the version.

bun run bump <semver>

Build the executable:

bun run build:all 

Then publish to npm:

bun run publish:all

Do not run bun publish directly, the executables are distributed as separate packages and need to be published separately.

Specs

File-viewer Frontend

In consideration of the tool might be running at a remote server, for easily viewing the Markdown files, we will use a simple file-viewer frontend. Data being sent to the frontend will be as encoded as an URL, using the following format:

https://yourfrontend.com/#name=...&comp=gzip&data=...

The data field is base64-encoded using compression algorithm specified in comp field. The frontend will decode the data and display it as a Markdown file.