polletfa / rmwebui Goto Github PK

Nice to have, low priority.

Security relevant options (passwords, certificates...) should be accessible only if the connection is secure (HTTPS or localhost request).

Manual configuration -should still be possible.
Ideally a simple format allowing comments like yaml should be used rather than json (no comments) or xml (strict syntax). It would be REALLY nice if the configuration interface didn't mess up the comments and formatting (can js-yaml do that?)
Probable more complicated than it is worth. Config over UI only would be fine but it should be at least possible to modify the default options with command line parameters (so that the user can specify at least a port on the first start, before s/he can access the configuration interface).

• Update README.md
• Update CHANGELOG.md
• Update version (package.json)
• Create tag
• PR develop -> main
• Create release

A bit more comprehensive than the current README

Add menu/button to display general information about the software (version, license, changelog...)

For demonstration mode

Implement create new folder in the cloud

doxygen or similar

Add accessibility information to frontend with ARIA.

See: https://w3c.github.io/using-aria/

• Update README.md
• Update CHANGELOG.md
• Update version (package.json)
• Create tag
• PR develop -> main
• Create release

Implement rename/remove of files and folders

See #17

• Update README.md
• Update CHANGELOG.md
• Update version (package.json)
• Create tag
• PR develop -> main
• Create release

• Update README.md
• Update CHANGELOG.md
• Update version (package.json)
• Create tag
• PR develop -> main
• Create release

Implement deleting files from the cloud

allow/deny based on hostname, remote address or HTTP headers

A change in the remarkable API has broken ReMarkableAPI and reMarkable-typescript.
The bug affects both PHP and TypeScript versions.

See issues:

• splitbrain/ReMarkableAPI#30
• benoitsepe/reMarkable-typescript#34.

Related issues in other projects:

• rschroll/rmfuse#42

Rewrite with NodeJS and Typescript because I strongly dislike PHP as it turns out... :-/

• Stand-alone application (not relying on a separate WebServer)
• NodeJS web server serving:
  • the frontend as a single file webapplication + favicon
    • build script to generate the frontend (using special include statements)
  • APIs:
    • /cloud/* -> Access the cloud - Dummy implementationfor this issue - separate issues for the actual implementations: #31 and #32
    • /backend/* -> Internal functionalities of the backend (e.g. login, logout...)
• HTTP session management required to implement the demo mode
• Multiple servers in parallel possible
• YAML config file
• Backend includes some configuration information as a JSON file inside the frontend file (using a marker)
• Tools/Build/Deployment in Typescript/NodeJS as well

Note: the implementation of the cloud API is out of scope of this issue

Experiment with github workflow (how does it work? what can it do?)

For each release, provide assets:

• source
• dist
• demo

remarkableAPI doesn't provide rename/move methods.
Is download, reupload and delete the only way to go?

Simple authentication mechanism, single user (just a password, no username).
For now, the password will be set using the config file, not through the interface

Implement uploading files to the cloud

single file, several files, directory (recursive)