mirror of
https://github.com/codeninjasgg/code-sensei.git
synced 2024-12-03 04:27:06 -05:00
49 lines
2.1 KiB
Markdown
49 lines
2.1 KiB
Markdown
# `sensei-grading-bookmarklet`
|
|
|
|
[![Bookmarklet Size][bookmarklet_size_badge]][bookmarklet_file]
|
|
|
|
> A bookmarklet to enhance the grading experience of code ninja assignments.
|
|
|
|
## Purpose
|
|
|
|
Grading code ninjas' submissions is slow and tedious because the current site has a poor user experience.
|
|
My goal is to make an entirely keyboard-navigable enhancement in the form of a bookmarklet.
|
|
|
|
## Usage
|
|
|
|
1. Visit the [grading console][grading_console] while logged in as a code sensei.
|
|
1. Paste the bookmarklet code in the [address bar](https://en.wikipedia.org/wiki/Address_bar).
|
|
1. [Make sure it is prefixed with `javascript:`](#security).
|
|
1. Click <kbd>enter</kbd> to execute the bookmarklet code.
|
|
1. Grade.
|
|
|
|
## Keybinds
|
|
|
|
| Key | Action |
|
|
| ---------------- | ------------------------------ |
|
|
| <kbd>i</kbd> | Marks assignment as incomplete |
|
|
| <kbd>s</kbd> | Skips to next assignment |
|
|
| <kbd>1</kbd> | Rates assignment as 1-star |
|
|
| <kbd>2</kbd> | Rates assignment as 2-star |
|
|
| <kbd>3</kbd> | Rates assignment as 3-star |
|
|
| <kbd>enter</kbd> | Submits assigment grade |
|
|
|
|
## Development
|
|
|
|
This [bookmarklet][bookmarklet_definition] is compiled using [NodeJS][node_installation].
|
|
Upon cloning this project, execute `npm i` to install of the necessary dependencies.
|
|
|
|
To run in development mode, run `npm run dev`.
|
|
To generate the bookmarklet, run `npm start`.
|
|
|
|
## Security
|
|
|
|
For security reasons, modern browsers will make you type out the prefix (`javascript:`) manually.
|
|
They use this as a method of opting into the potentially dangerous act of executing foreign JavaScript on a webpage.
|
|
This code, however, is non-malicious, so no worries.
|
|
|
|
[grading_console]: https://gdp.code.ninja/Grading
|
|
[bookmarklet_definition]: https://en.wikipedia.org/wiki/Bookmarklet
|
|
[node_installation]: https://nodejs.org/en/download/
|
|
[bookmarklet_size_badge]: https://img.shields.io/github/size/EthanThatOneKid/code-sensei/sensei-grading-bookmarklet/bookmarklet.txt?label=bookmarklet%20size
|
|
[bookmarklet_file]: https://raw.githubusercontent.com/EthanThatOneKid/code-sensei/main/sensei-grading-bookmarklet/bookmarklet.txt
|