KonnorRogers
Purpose
To create a grab and go WYSIWYG editing experience that can hook into Ruby on Rails ActionText backend. Currently this package does so using TipTap but will most likely include another integration for ProseMirror to allow for both Markdown + WYSIWYG editing.
Documentation
https://rhino-editor.vercel.app
Local Development
This section is for contributing to Rhino Editor.
Getting up and running locally is hopefully quite painless. We have a test suite using Ruby on Rails and is intended to provide a good demonstration of how this package can hook into ActionText.
Contributions should be made on a feature branch in a forked repository.
Prerequisites
- Ruby 3.1.2
- Rails 7.0.4
- PNPM (
npm install -g pnpm) - Playwright (
npm install -g playwright) - Node >= 16
- Docker (Used to run a simulated S3 server)
- A Docker virtualizer (Orbstack or Docker Desktop)
- Overmind (Preferred, not needed
npm install -g overmind)
Installation
Run the following commands in the bash to setup dependencies:
git clone https://github.com/konnorrogers/rhino-editor
cd rhino-editor
pnpm run setupRunning the server
The easiest way to run the server is using Overmind. First start up your Docker virtualizer, then in two termainals…
Terminal 1:
pnpm run startTerminal 2:
cd tests/rails
overmind start -f Procfile.devThen navigate to localhost:5100
Without Overmind
To run the server without Overmind do the following in seperate terminals:
bin/vite dev --clobber
bin/rails s
docker compose up --buildThen navigate to localhost:5100
Running the test suite
Make sure to have the docker server up and running, the test suite will fail without it.
docker compose up --build
bundle exec rails test:allListening for changes to the package
To listen for changes, keep your rails server running and open a new terminal with the following:
pnpm run startThis will start an ESBuild watcher process. Vite in Rails will automatically pick up changes.
Adding a changelog entry
To add a changelog entry, we use https://github.com/changesets/changesets. Run the following command and then answer the prompts:
pnpm changesetRoadmap to v1
- <input disabled="" type="checkbox">
- Collaboration Extension. Support collaboration!
- <input disabled="" type="checkbox">
- Document slots, CSS properties, Extending ActionText, and show common demo examples
- <input disabled="" type="checkbox">
- Create a ProseMirror base for a markdown + rich text editor
- <input disabled="" type="checkbox">
- Move the TipTap editor to extend the ProseMirror editor.
- <input disabled="" type="checkbox">
- Show how to do table editing
- <input disabled="" type="checkbox">
- Show how to do embeds
- <input disabled="" type="checkbox">
- Show how to do mentions
- <input disabled="" type="checkbox">
- Add testing for the basic operations bold, strike, etc.
- <input disabled="" type="checkbox">
- Add testing for ActionText / Trix compatibility.