An open API service indexing awesome lists of open source software.

https://github.com/sliit-foss/scorekeeper

An automated testing and scoring solution which leverages the power of GitHub Actions
https://github.com/sliit-foss/scorekeeper

automated-testing bash bashaway

Last synced: 3 months ago
JSON representation

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

Awesome Lists containing this project

README

        




Bashaway Logo










# Scorekeeper

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

---

## Invoking tests

```bash
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](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#examples)
- Refer the [commitlint.config.js](https://github.com/sliit-foss/scorekeeper/blob/main/commitlint.config.cjs) file for a full list of supported commit message prefixes

## Additional tools

- This project is bootstrapped with [Lefthook](https://evilmartians.com/opensource/lefthook), [Eslint](https://eslint.org/) and [Prettier](https://prettier.io/). Please make good use of them.