README.md

Scorekeeper

An automated testing and scoring solution which leverages the power of GitHub Actions

---

Invoking tests

curl --location 'https://api.github.com/repos/sliit-foss/scorekeeper/dispatches' \
--header 'Authorization: Bearer {{personal_access_token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "event_type": "run-{{env}}-tests",
    "client_payload": {
        "name": "Runtime Terror",
        "email": "[email protected]",
        "submission_id": "64d295ffc4d6d90618f8bf79",
        "submission_url": "{{url}}/submission.zip",
        "question_url": "{{url}}/question.zip",
        "question_name": "Fools Gold",
        "strict_inputs": true
    }
}'

Constraints

• The runner OS is Ubuntu 20.04 LTS. Please make sure your submission scripts are compatible with it.
• Jobs must finish executing within a maximum of 5 minutes
• All tests must pass for a submission to be scored

Getting started

• Run pnpm install to install all dependencies
• Run pnpm dev to start the development server

Commit messages

• We follow conventional commits during our development workflow as a good practice. More information can be found at their official documentation
• Refer the commitlint.config.js file for a full list of supported commit message prefixes

Additional tools

• This project is bootstrapped with Lefthook, Eslint and Prettier. Please make good use of them.