https://github.com/oleks/html-remarks

A zero-install, server-less implementation of remarks
https://github.com/oleks/html-remarks

grading marking qualitative quantitative serverless students university zero-install

Last synced: 24 days ago
JSON representation

A zero-install, server-less implementation of remarks

• Host: GitHub
• URL: https://github.com/oleks/html-remarks
• Owner: oleks
• License: bsd-3-clause
• Created: 2017-10-18T13:03:08.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-29T18:55:37.000Z (over 6 years ago)
• Last Synced: 2024-10-27T17:50:31.715Z (2 months ago)
• Topics: grading, marking, qualitative, quantitative, serverless, students, university, zero-install
• Language: TypeScript
• Homepage: https://oleks.github.io/html-remarks/remarks.html
• Size: 148 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# A zero-install, server-less implementation of remarks

[![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](LICENSE)

This is a zero-install, HTML-resident implementation of

[remarks](https://github.com/DIKU-EDU/remarks). `remarks` was originally a DSL,

but it proves a hassle to have people install software on their systems.

## Design

* Zero install for all: Both teachers and students should be able to open a

  remarks file in their browser.

* Save-and-resume: Manipulate the DOM rather than the JavaScript run-time. This

  enables saving the file once changes have been made to the document.

* Mobile-first for students: When a remarks file is finalized for student view,

  this student view should be friendly for view on handheld devices (tablet, or

  mobile).

## TypeScript Style Guide

* Don't use `var` for non-variables, use `let`.

* Don't use `document.createElement` without a wrapper function that hence

  asserts a type for the created element.

* Always use `===`.

* Always specify the return type of a function (especially, if it is `void`).