A Workflowy clone that works offline, signed out and allows plugging in your own storage
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3d4f4eb Nov 16, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src add github-corner Nov 16, 2018
.editorconfig bootstrap Sep 23, 2018
.gitignore <x-test>: handle enter and tab keypress events Sep 23, 2018
CHANGELOG update changelog Oct 29, 2018
LICENSE initial commit Sep 23, 2018
README.md update readme Oct 25, 2018
package.json 0.1.13 Nov 16, 2018
rollup.config.js build: set up html minification Oct 25, 2018
tsconfig.dev.json fix prod build Oct 4, 2018
tsconfig.json add IDB store Sep 23, 2018
tslint.json bootstrap Sep 23, 2018
yarn.lock build: set up html minification Oct 25, 2018

README.md

flowy

Open Source Workflowy implementation.

3 main goals

  • Works Offline: It installs a service worker and works using IndexedDB as an offline first cache.
  • Works signed out: No need to sign in to anything to use it, works out of the box with the browser cache. The browser cache will generally persist unless it is unused for a very long time.
  • "Moving" Storage: To get off-browser persistence and sync the same set of tasks on another device, allows plugging in your own storage server with an verification key, allowing resyncing the remote storage with your local tasks, or vice-versa. There are also a couple of sample server implementations for trying things out.

For persistence, there are a couple of server implementations in flowy-servers.

  • TODO: Multi-Device Sync: Currently the sync will update a task with wherever the latest update comes from, which is not a great strategy for using the same storage on multiple devices.

Hacking

yarn install
yarn watch

will start watching files for updates.

yarn start

will start a local server on 3000.