/Notoy-PWA

Notoy is web app to save notes of a website on a mobile device. You can also use and install it as an app on a desktop, but you cannot share an URL from a browser to Notoy. Uses Purescript

Primary LanguagePureScriptGNU General Public License v3.0GPL-3.0

Warning

This repository has been moved to Codeberg: Notoy Progressive Web App

The App itself has been moved to Notoy PWA at Codeberg Pages

Notoy Progressive Web App

Documentation Status Build Tests GitHub Pages

Notoy is web app to save notes of a website on a mobile device. You can also use and install it as an app on a desktop, but you cannot share an URL from a browser to Notoy. For a video of the mobile usage, see: YouTube video of the app on Android

The app can be found at Notoy PWA at GitHub Pages

Some words on the 'why' you can read in the section PureScript

If you want something comparable for a 'normal' browser, I also made browser extensions called Notoy to work with desktop browsers: Notoy Browser Extensions

Notoy app on mobile

Links

Further Information about some Markdown note programs and Emacs' Org-Mode:

Usage and Installation

Installation

Visit the URL Notoy PWA at GitHub Pages and you can install the app if you have a mobile device or a computer with Chrome or Edge.

Firefox does not allow to install the app and cannot share the note with other programs or the clipboard. Therefore the Install- and Share-buttons are missing: Screenshot of the website in Firefox

On mobile devices you have to click the Install Notoy to Home Screen-badge at the bottom of the site. See: YouTube video of the app on Android

Here you can see the Install-button marked in the upper right corner of a Chrome browser. After clicking, the app is installed on your computer.You do only need connection to the internet if you want to get the name of your location from the website BigData. Screenshot of the installation of the desktop app using Chrome The same Install-button on Edge. Screenshot of the installation of the desktop app using Edge Below are two screenshots of the installed app on a computer, the first is using Chrome, the second Edge. Screenshot of the installed app in Chrome

Screenshot of the installed app in Edge

Usage

See the YouTube video on how to share a website to Notoy and save the note: YouTube video of the app on Android

Notoy can save the note in one of three formats: as markdown to be used with programs like Obsidian, Zettlr, Joplin, ... as an Org-Mode file to use with Emacs or as a simple, plain text file.

PureScript

This is mainly a project to try PureScript and less a 'serious' attempt at a note app, so the PureScript specific things shown in this app are:

  • Mainly writing a progressive web app in PureScript (not the service worker, this is more or less an autogenerated list of files to cache)
  • Using Halogen
  • Using a PureScript PWA as a share target
  • Sharing text from a PureScript PWA
  • Using the geolocation API
  • Doing reverse geolocation using a web API (using BigData's geolocation services)
  • Wrapping callbacks in an Aff (getCurrentPosition geolocation function)
  • Doing JavaScript FFI

Contributing

Every help is welcome, if you found a bug or want to request a missing feature, go to Report a Bug or a Feature Request at GitHub

For detailed information, see Contributing at Read the Docs

Privacy Policy

Notoy (the progressive web app) does not send any data at all to any other host as long as the reverse geolocation is disabled in the options - which is the default.

If you enable the option to look the GPS coordinates up at BigData, a request is send to BigData to get the name of the city this position is nearest to. BigData adheres to the the EU General Data Protection Regulations (GDPR) and the Australian Privacy Principles contained in the Privacy Act 1988 (Cth).

The privacy policy of BigData can be seen at BigData Privacy Policy

License

The app is licensed under the GPL v3 and newer, see file LICENSE