Skip to content

corvec/sn-kanban-editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

40 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kanban Editor for Standard Notes

Kanban Icon

Introduction

The Kanban Editor is an unofficial editor for Standard Notes, a free, open-source, end-to-end encrypted notes app.

It integrates rcdexta/react-trello, a Kanban board editor, and saves your notes in Markdown so that you can easily read them, export them to Listed, etc..

Because Standard Notes has not yet implemented collaborative editing, the main use case is for a personal Kanban board. However, I believe private workspaces can be shared to enable asynchronous collaboration.

NOTE: The file format is much more stable now, but it will continue to evolve. I plan to keep the file format backwards compatible. However, it is possible that changes will be required in the future that could cause incompatibilities with existing notes. If possible, I will provide a migration tool to convert your notes to the new format.

Demo

Try out the demo here! Note that any changes you make will be lost when you close your browser tab.

Installation

  1. Open the Standard Notes web or desktop app.
  2. In the lower left corner of the app, click Extensions.
  3. In the lower right corner, click Import Extension.
  4. In the input box appears, paste:
https://corvec.github.io/sn-kanban-editor/ext.json
  1. Confirm adding the Kanban Editor.
  2. Create a new note.
  3. Open the "Editor" menu and then select "Kanban Editor"
  4. Add a lane, add some cards, and have fun!

Features

  1. Manage cards with titles, descriptions, and labels
  2. Drag and drop the cards between different "lanes"

Project Roadmap

Please refer to the Projects Roadmap for details on planned future development (if any).

Development and Running Locally

Prerequisites:

  1. (Optional) Fork this repo on Github.
  2. Clone this repo or your fork.
  3. Run cd sn-kanban-editor and then npm install to install all dependencies.

Testing in the browser

  1. Run
npm start
  1. Your browser may open automatically. If not, open your browser and navigate to http://localhost:3001/
  2. When you're done, in the console, press ctrl/cmd + C to stop running the app.

Testing in your local Standard Notes app

  1. An ext.dev.json file is already present in the public directory. You may wish to edit it.
  2. To build the app, run
npm run build
  1. To serve the app, run
npm run server
  1. Install the editor into the web or desktop app by installing:
http://localhost:3000/ext.json
  1. When you're done, in the console, press ctrl + C to shut down the server.

If you run into issues, please refer to the StandardNotes instructions for local setup

Deployment

  1. Update the package.json version, the public/ext.json version, and the public/ext.dev.json version
  2. Update the following command to account for the updates that you wish to deploy as well as the current version, then run it.
npx gh-pages -b gh-pages -d build -m "Support comments on cards (show modal on click)" -g "v0.4.0"
  1. On GitHub, create a new release corresponding to that tag.

This project was forked from StandardNotes/editor-template-cra-typescript, which was bootstrapped with Create React App.