quasar-tiptap icon indicating copy to clipboard operation
quasar-tiptap copied to clipboard

Getting this working and wondering how to set up a simple way to contribute

Open flowt-au opened this issue 3 years ago • 1 comments

Hi. Thanks for this great package. I am not that experienced with updating and contributing to npm packages so some of this might be obvious, but not to me. Below is a list of the things I needed to do in order to get this working with Quasar v1 / Vue 2 and I also want to make a few changes and maybe even some of my own extensions that I could share.

Setup adjustments I seem to have needed using current TipTap versions:

  1. Start a new Quasar V1 project > quasar create tiptaptest --branch v1
  2. Install tiptap in tiptaptest > npm install @tiptap/vue-2 @tiptap/starter-kit
  3. Install quasar-tiptap > npm i quasar-tiptap
  4. As a side-issue in VSCode: turn off vetur.experimental.templateInterpolationService
  5. I need tables so I also npm installed @tiptap/extension-table, @tiptap/extension-table-row, @tiptap/extension-table-cell, @tiptap/extension-table-header as well as prosemirror-tables v1.1.1
  6. See my note at the end of Issue #54 for a fix re the Duplicate use of selection JSON ID cell error.
  7. Copy the relevant bits from quasar-tiptap sample quasar.conf.js file - especially the locale and components list After all that I was able to get a test version of quasar-tiptap working. :-)

Contributing?

As I said above there are some things I want to add and they might be useful to others. I have been using a customised version of TinyMCE and would like to re-implement some of those things in Tiptap. At a minimum I wanted to offer a PR to update the README.md as per the list above (if that is all correct, of course). Before I do that I need to test it all.

My struggle is in setting up a local dev version of quasar-tiptap so I can write and test without having to rebuild all the time. I am using the npm link approach but it looks like I will need to rebuild after each change - not ideal. And, I haven't worked out how to do that, either!

Can anyone offer a process for setting up a local dev version of quasar-tiptap so I can get to work please?

Thanks. As I said, npm package development is new territory for me and I would love to contribute to this extension. Murray

flowt-au avatar Jan 02 '22 03:01 flowt-au

I think I need to learn about https://quasar.dev/app-extensions/introduction

flowt-au avatar Jan 02 '22 20:01 flowt-au