Skip to content

Burize/notes-redactor

Repository files navigation

NOTER REDACTOR

Note redactor for creating and managing notes. Notes writes at markdown and parses at same time.

This is PWA app:

  • All fetches handle by SW and static assets has been cached;
  • It has storage for opportunity to use app when there is no network connection. When network connection appears, all unsaved actions send for backend server via sync api;
  • It has manifest, therefore it is possible to launch the application from the main screen of a mobile device.

Redactor following markdown tags:

  • h1: #
  • h2: ##
  • h3: ###
  • h4: ####
  • bold: *word*
  • italic: /word/
  • underline: _word_
  • crossing: -word-
  • link: [title](url)
  • code: `word`
  • checkboxes: [ ] [x]
  • unordered list: * listItem

Used features

  • React/Redux;
  • Typescript;
  • Redux-Saga for handle side-effects at redux;
  • Axios for handle http actions;
  • Semantic UI as components kits;
  • IndexedDB as offline storage;
  • Web Worker(dedicated) for parse markdown / Service Worker for cache assets and handle fetch offline.

Project launch

For working at online mode, you need the back-end rest server. However, you can launch project without it and working offline: (there is empty notes list and all next actions will stored at storage)

NPM scripts

  • npm run dev for development environment in watch mode
  • npm run prod for production environment in watch mode
  • npm run analyze:dev for bundle analyzing

About

PWA markdown redactor

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages